[Emacs-commit] Re: emacs/lisp/mh-e mh-utils.el mh-seq.el mh-pick.e...

[Mark D. Baushke]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Bill Wohler <address@hidden> writes:

>       * mh-alias.el (mh-alias-grab-from-field): Remove leading * from
>       docstring. Does this mean something in a defun?

You raise a good question.

I know that a leading `*' in the DOCSTRING of a defcustom or defvar may
be used to mark it as a "user option" for the user-variable-p and
set-variable functions. (See the DOCSTRING for defvar itself.)

However, I do not know of any special meaning in a defun.

Yet, I see a leading "*" used in a few other places in the CVS emacs:

  - allout.el uses a leading "*..." in DOCSTRING text for
    allout-reset-header-lead and allout-lead-with-comment-string

  - bs.el uses "*..." for bs-config-clear

  - imenu.el uses "*..." for imenu-default-create-index-function

  - calendar/solar.el uses it for solar-equinoxes-solstices, but
    *local* makes sense in that DOCSTRING.

  - mail/feedmail.el uses "*..." for feedmail-queue-express-to-queue
    and feedmail-queue-express-to-draft

  - mh-e/mh-alias.el uses "*..." for mh-alias-add-alias

  - progmodes/sh-script.el uses "*..." for sh-must-support-indent

There may be others, but those were the only instances I saw with a
quick grep through the sources.

I suspect that they should all be fixed just as you have fixed the
DOCSTRING for mh-alias-grab-from-field.
  
        -- Mark
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (FreeBSD)

iD8DBQFDuh54Cg7APGsDnFERAqCqAKCdkc85pUYDoOFuvcZs0UfA2qU5AwCeOwac
mR+skOBvoOUashTrLr0dv9Y=
=hzZ7
-----END PGP SIGNATURE-----