[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Wrong "Not documented" message, bug?
From: |
PJ Weisberg |
Subject: |
Re: Wrong "Not documented" message, bug? |
Date: |
Thu, 14 Oct 2010 16:03:31 +0000 |
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.