Wrong "Not documented" message, bug?

Wrong "Not documented" message, bug?

[Andreas Röhler]

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?

Thanks


Andreas

--
https://code.launchpad.net/~a-roehler/python-mode/python-mode-components
https://code.launchpad.net/s-x-emacs-werkstatt/


PS: If interested, see the complete files contents at

http://bazaar.launchpad.net/~a-roehler/python-mode/python-mode-components/annotate/head%3A/python-components-intern.el

Re: Wrong "Not documented" message, bug?

[Ralf Mattes]

On Thu, 14 Oct 2010 10:21:59 +0200, Andreas Röhler 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?

How about adding a docstring? :-)
Something like:

 (defun py-in-string/comment ()
  "Returns character address of start of comment or string; nil if not
in one. "
   ....


 HTH Ralf Mattes 
> Thanks
> 
> 
> Andreas
> 
> --
> https://code.launchpad.net/~a-roehler/python-mode/python-mode-components
> https://code.launchpad.net/s-x-emacs-werkstatt/
> 
> 
> PS: If interested, see the complete files contents at
> 
> http://bazaar.launchpad.net/~a-roehler/python-mode/python-mode-
components/annotate/head%3A/python-components-intern.el

Re: Wrong "Not documented" message, bug?

[PJ Weisberg]

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.

Re: Wrong "Not documented" message, bug?

[Andreas Röhler]

Am 14.10.2010 18:03, schrieb PJ Weisberg:
> 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.
>
>

Oh yeah, thanks all.

Re: Wrong "Not documented" message, bug?

[Marc Mientki]

Am 14.10.2010 10:21, schrieb Andreas Röhler:
>
> 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?

See at '<----'. Doc string must come first.

regards
Marc