Re: Separating obarray handling from abbrevs

[Stephen Leake <stephen_leake@stephe-leake.org>]

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