From: Eli Zaretskii <eliz@gnu.org>
To: "Basil L. Contovounesios" <contovob@tcd.ie>
Cc: jonas@bernoul.li, monnier@iro.umontreal.ca, johnw@gnu.org,
emacs-devel@gnu.org
Subject: Re: Un-deprecating oset
Date: Sat, 06 Jun 2020 10:38:43 +0300 [thread overview]
Message-ID: <837dwkabjw.fsf@gnu.org> (raw)
In-Reply-To: <87img8ulmu.fsf@tcd.ie> (contovob@tcd.ie)
> 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.
next prev parent reply other threads:[~2020-06-06 7:38 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-05 10:34 Un-deprecating oset Jonas Bernoulli
2020-05-05 10:48 ` Philippe Vaucher
2020-05-05 11:11 ` Basil L. Contovounesios
2020-05-05 14:50 ` Stefan Monnier
2020-05-12 15:06 ` Jonas Bernoulli
2020-05-12 16:49 ` Philippe Vaucher
2020-05-12 21:47 ` Adam Porter
2020-05-13 13:04 ` Philipp Stephani
2020-05-14 7:50 ` Juanma Barranquero
2020-05-14 12:13 ` Basil L. Contovounesios
2020-05-14 12:31 ` Juanma Barranquero
2020-05-17 21:19 ` Jonas Bernoulli
2020-05-24 20:09 ` Jonas Bernoulli
2020-05-25 15:21 ` Eli Zaretskii
2020-05-25 16:06 ` Stefan Monnier
2020-05-25 16:25 ` Eli Zaretskii
2020-06-03 14:03 ` Basil L. Contovounesios
2020-06-03 17:03 ` Basil L. Contovounesios
2020-06-06 7:38 ` Eli Zaretskii [this message]
2020-06-06 16:43 ` Basil L. Contovounesios
2020-06-08 12:42 ` Jonas Bernoulli
2020-05-25 17:27 ` Jonas Bernoulli
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=837dwkabjw.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=contovob@tcd.ie \
--cc=emacs-devel@gnu.org \
--cc=johnw@gnu.org \
--cc=jonas@bernoul.li \
--cc=monnier@iro.umontreal.ca \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).