From: Stephen Leake <stephen_leake@stephe-leake.org>
To: "Przemysław Wojnowski" <esperanto@cumego.com>
Cc: Artur Malabarba <bruce.connor.am@gmail.com>,
Emacs Developers <emacs-devel@gnu.org>
Subject: Re: Separating obarray handling from abbrevs
Date: Mon, 09 Nov 2015 03:38:39 -0600 [thread overview]
Message-ID: <86r3jza4ww.fsf@stephe-leake.org> (raw)
In-Reply-To: <87lha8jimn.fsf@cumego.com> ("Przemysław Wojnowski"'s message of "Sun, 08 Nov 2015 22:17:36 +0100")
Przemysław Wojnowski <esperanto@cumego.com> writes:
> Artur Malabarba <bruce.connor.am@gmail.com> writes:
>
>>> +(defun obarray-make (&optional size)
>>> + "Return a new obarray of size `SIZE' or `obarray-default-size'."
>>
>> Use SIZE, not `SIZE'. Similarly everywhere else.
The markup for arguments (like "size") is all caps. The markup for other
variables/defuns (like "obarray-default-size") is quotes.
>>> +(defun obarray-get (obarray name)
>>> + "Return from obarray `OBARRAY' symbol with `NAME' or nil."
>>
>> I'd use:
>> "Return symbol named NAME if it is contained in OBARRAY.
>> Return nil otherwise."
>>
>> And I would repeat this throughout the docstrings.
> Will do that.
Then you have to ignore complaints from the comment style checker, which
insists on listing the arguments in order in the doc string. There was a
proposal recently to delete that check.
--
-- Stephe
next prev parent reply other threads:[~2015-11-09 9:38 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-10-31 13:21 Separating obarray handling from abbrevs Przemysław Wojnowski
2015-11-01 13:11 ` Artur Malabarba
2015-11-01 22:17 ` Przemysław Wojnowski
2015-11-02 20:21 ` John Wiegley
2015-11-08 18:50 ` Przemysław Wojnowski
2015-11-08 18:54 ` Eli Zaretskii
2015-11-08 19:09 ` Przemysław Wojnowski
2015-11-08 19:59 ` Eli Zaretskii
2015-11-08 21:05 ` Artur Malabarba
2015-11-08 21:17 ` Przemysław Wojnowski
2015-11-09 9:38 ` Stephen Leake [this message]
2015-11-08 21:36 ` Przemysław Wojnowski
2015-11-09 0:29 ` Artur Malabarba
2015-11-09 18:24 ` Przemysław Wojnowski
2015-11-09 23:12 ` Nicolas Petton
2015-11-09 23:18 ` John Wiegley
2015-11-10 20:10 ` Przemysław Wojnowski
2015-11-10 20:32 ` John Wiegley
2015-11-10 20:37 ` Eli Zaretskii
2015-11-10 20:54 ` Przemysław Wojnowski
2015-11-11 4:27 ` Ken Raeburn
2015-11-11 16:51 ` Nicolas Petton
2015-11-10 20:39 ` Przemysław Wojnowski
2015-11-10 21:55 ` Artur Malabarba
2015-11-10 22:19 ` Drew Adams
2015-11-10 22:26 ` John Wiegley
2015-11-11 3:31 ` Eli Zaretskii
2015-11-11 5:08 ` Drew Adams
2015-11-11 10:40 ` David Kastrup
2015-11-11 16:50 ` Nicolas Petton
2015-11-11 16:56 ` Nicolas Petton
2015-11-11 16:57 ` John Wiegley
2015-11-19 23:23 ` Nicolas Petton
2015-11-20 0:13 ` John Wiegley
2015-11-20 1:01 ` Artur Malabarba
2015-11-20 7:52 ` Przemysław Wojnowski
2015-11-10 22:01 ` Nicolas Petton
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86r3jza4ww.fsf@stephe-leake.org \
--to=stephen_leake@stephe-leake.org \
--cc=bruce.connor.am@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=esperanto@cumego.com \
/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.
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.