[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Un-deprecating oset
From: |
Eli Zaretskii |
Subject: |
Re: Un-deprecating oset |
Date: |
Sat, 06 Jun 2020 10:38:43 +0300 |
> 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:
. 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?
Thanks.