* Convention about `*' in docstrings?
@ 2008-02-25 9:06 Bastien
0 siblings, 0 replies; only message in thread
From: Bastien @ 2008-02-25 9:06 UTC (permalink / raw)
To: emacs-devel
I need to be enlightened about the use of `*' in docstrings.
Last changes by Miles (in mail-source.el and nnmail.el) and Glenn (in
smtpmail.el) removed the leading `*' in some docstrings.
I somewhat thought that using `*' in docstrings was obsolete, and these
changes seem to confirm that (to a limited extent: no case can "confirm"
a rule.)
But I read the manual and found this:
,----[ (info "(elisp)Documentation Tips") ]
| * When you define a variable that users ought to set interactively,
| you normally should use `defcustom'. However, if for some reason
| you use `defvar' instead, start the doc string with a `*'. *Note
| Defining Variables::.
`----
Fair enough.
,----[ (info "(elisp)Defining Variables") ]
| If the variable is a user option that users would want to set
| interactively, you should use `*' as the first character of
| DOC-STRING. This lets users set the variable conveniently using the
| `set-variable' command. Note that you should nearly always use
| `defcustom' instead of `defvar' to define these variables, so that
| users can use `M-x customize' and related commands to set them.
`----
Is this still accurate?
Can someone provide a simple summary of good practices regarding `*' in
docstrings? Thanks in advance.
--
Bastien
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2008-02-25 9:06 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-02-25 9:06 Convention about `*' in docstrings? Bastien
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.