[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Un-deprecating oset
From: |
Basil L. Contovounesios |
Subject: |
Re: Un-deprecating oset |
Date: |
Sat, 06 Jun 2020 17:43:33 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) |
Eli Zaretskii <eliz@gnu.org> writes:
>> From: "Basil L. Contovounesios" <contovob@tcd.ie>
>> Cc: Stefan Monnier <monnier@iro.umontreal.ca>, jonas@bernoul.li,
>> johnw@gnu.org, emacs-devel@gnu.org
>> Date: Wed, 03 Jun 2020 18:03:53 +0100
>>
>> +@defmac oref obj slot
>> +@anchor{oref}
>> +This macro retrieves the value stored in @var{obj} in the slot named
>> +by @var{slot}. @var{slot} is the name of the slot when created by
>> +@dfn{defclass}.
>
> Two minor stylistic points:
Thanks, I incorporated your suggestions and pushed the two patches to
master and emacs-27, respectively.
Un-deprecate oset and oset-default
8bcc781bc7 2020-06-06 17:24:00 +0100
https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=8bcc781bc762b4082cfd678b88938e3d03465d91
Minor improvements to EDE and EIEIO manuals
d8593fd19f 2020-06-06 16:35:52 +0100
https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=d8593fd19ffdb1fa62f0b0c4b971cfdb325fbe1d
> . It is many times better to use the argument name as an integral
> part of the sentence, instead of separating it. For example:
>
> This macro retrieves the value stored in @var{obj} in the named
> @var{slot}.
>
> . It is better to avoid starting a sentence with @var{something},
> because in the printed version of the manual @var{..} doesn't
> capitalize its argument, so you get a sentence that starts with a
> lower-case letter, which is not valid English. (Yes, we have a lot
> of examples of this sub-optimal usage our manuals.) In this case,
> I would rephrase:
>
> Slots names are determined by @dfn{defclass} which creates the
> slot.
>
> Btw, why is "defclass" in @dfn here?
I saw no reason for it so changed it to @code instead.
Thanks,
--
Basil