From: PJ Weisberg <pj@irregularexpressions.net>
To: help-gnu-emacs@gnu.org
Subject: Re: Wrong "Not documented" message, bug?
Date: Thu, 14 Oct 2010 16:03:31 +0000 [thread overview]
Message-ID: <AANLkTins3E=6ZUPREJnD0V+8vZ_FbFW0e54R=Coe9RcW@mail.gmail.com> (raw)
In-Reply-To: <4CB6BDA7.7040204@easy-emacs.de>
On Thu, Oct 14, 2010 at 8:21 AM, Andreas Röhler
<andreas.roehler@easy-emacs.de> wrote:
>
> Hi,
>
> M-x describe-function `py-in-string/comment' points me to the code below,
> which is correct:
>
>
> (defun py-in-string/comment ()
> (interactive)
> "Returns character address of start of comment or string; nil if not in
> one. "
> (lexical-let ((erg (nth 8 (syntax-ppss))))
> (unless erg (when (or (looking-at "\"\"\"")
> (looking-at (concat "^[ \t]*" comment-start-skip)))
> (setq erg (point))))
> (when (interactive-p) (message "%s" erg))
> erg))
>
> However, it says:
>
> ,----
> | py-in-string/comment is an interactive Lisp function in
> | `python-components-intern.el'.
> |
> | (py-in-string/comment)
> |
> | Not documented.
> `----
>
> Something odd with doku here? A bug?
The docstring has to be the *first* statement in the function. Not
even the (interactive) call can come before it.
next prev parent reply other threads:[~2010-10-14 16:03 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-10-14 8:21 Wrong "Not documented" message, bug? Andreas Röhler
2010-10-14 13:08 ` Ralf Mattes
2010-10-14 16:03 ` PJ Weisberg [this message]
2010-10-15 11:50 ` Andreas Röhler
[not found] <mailman.1.1287045328.32083.help-gnu-emacs@gnu.org>
2010-10-14 8:59 ` Marc Mientki
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='AANLkTins3E=6ZUPREJnD0V+8vZ_FbFW0e54R=Coe9RcW@mail.gmail.com' \
--to=pj@irregularexpressions.net \
--cc=help-gnu-emacs@gnu.org \
/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.
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).