unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Nick Roberts <nickrob@snap.net.nz>
To: Whitfield Diffie <whitfield.diffie@sun.com>
Cc: bug-gnu-emacs@gnu.org
Subject: Re: Missing arglist for char-after
Date: Thu, 14 Jun 2007 11:45:06 +1200	[thread overview]
Message-ID: <18032.33154.129481.151929@kahikatea.snap.net.nz> (raw)
In-Reply-To: <200706131744.l5DHiDUg014876@ushabti.sfbay.sun.com>

[2nd attempt]

[please cc the mailing list, other people might have better ideas]

 >     Well in mine
 > 
 > 	/pkg/gnu/share/emacs/22.1/etc/DOC-22.1.1
 > 
 > it looks a little different.  I am not certain how to read it so I have
 > included a bit of context.

Mine looks the same.  I just left out the control characters (because I wasn't
sure what mail would do to them).

 >     (fn)\x1fFeolp
 >     Return t if point is at the end of a line.
 >     `End of a line' includes point being at the end of the buffer.
 > 
 >     (fn)\x1fFchar-after
 >     Return character in current buffer at position POS.
 >     POS is an integer or a marker and defaults to point.
 >     If POS is out of range, the value is nil.
 > 
 >     (fn &optional POS)\x1fFchar-before
 >     Return character in current buffer preceding position POS.
 >     POS is an integer or a marker and defaults to point.
 >     If POS is out of range, the value is nil.
 > 
 > The context makes it look as though char-after is screwed up but char-before
 > is ok.  However, asking for a description of the function char-before
 > produces the same result

No this is alright.  The arglist comes _after_ the documentation, so
the (fn &optional POS) you see is for Fchar-after and the one for Fchar-before
(not shown) is attached to Fuser-login-name.

I'm afrraid I don't know why it doesn't work for you.  You need to use Edebug
on describe-function-1:

1) Do `C-u ESC C-x' inside describe-function-1.
2) C-h f <RET> char-after <RET>
3) The function describe-function-1 should appear in a buffer.  Move to the 
   beggining of the line:

     (let* ((arglist (help-function-arglist def))

   and press h.

4) Step through describe-function-1 (press SPC).
5) See what value the variable `usage' has.
   I suspect that it is nil but it should be:

("(char-after &optional POS)" . "Return character in current buffer at position POS.\nPOS is an integer or a marker and defaults to point.\nIf POS is out of range, the value is nil.")

This value comes from the DOC file through help-split-fundoc and documentation.

-- 
Nick                                           http://www.inet.net.nz/~nickrob

      parent reply	other threads:[~2007-06-13 23:45 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-06-13  0:24 Missing arglist for char-after Whitfield Diffie
2007-06-13  4:08 ` Nick Roberts
     [not found]   ` <200706131744.l5DHiDUg014876@ushabti.sfbay.sun.com>
2007-06-13 23:45     ` Nick Roberts [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=18032.33154.129481.151929@kahikatea.snap.net.nz \
    --to=nickrob@snap.net.nz \
    --cc=bug-gnu-emacs@gnu.org \
    --cc=whitfield.diffie@sun.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).