From: Alejandro Colomar <alx@kernel.org>
To: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Jeremy Baxter <jtbx@disroot.org>, linux-man@vger.kernel.org
Subject: Re: [PATCH v2 1/6] intro.1: Revise language
Date: Mon, 18 Mar 2024 23:05:09 +0100 [thread overview]
Message-ID: <Zfi6lSKPCBTiuxVg@debian> (raw)
In-Reply-To: <20240318195657.bihsax5gk5jx5tyc@illithid>
[-- Attachment #1: Type: text/plain, Size: 1274 bytes --]
Hi Jeremy, Branden,
On Mon, Mar 18, 2024 at 02:56:57PM -0500, G. Branden Robinson wrote:
> At 2024-03-19T08:50:21+1300, Jeremy Baxter wrote:
> > > cat will show
> > > but
> > > cp copies
> > > ?
> >
> > I think it sounds better to use the "x does this" form rather than the
> > "x will do this" form, similar to what they have in the utilities' own
> > man pages. What do you think? Should I change cat's description to
> > adhere to the rest or just keep all of them as they were?
>
> Two rules I've been applying to my man page revisions for a while are:
>
> * Favor active voice over passive.
> * Favor present tense over future.
>
> This is "favor", not "always use", but, other things being equal...
For intro(1), we could make an exception. A less formal voice might
seem more friendly to newcomers. Don't you think?
BTW Jeremy, you could send less changes. I'm not very happy about such
huge changes suddenly. How about fixing what you feel is most obvious
that should be fixed, say 20 lines or so, and in a month or so we can
discuss another patch set for this page?
Have a lovely day!
Alex
>
> Regards,
> Branden
--
<https://www.alejandro-colomar.es/>
Looking for a remote C programming job at the moment.
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2024-03-18 22:05 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-17 8:08 [PATCH v2 1/6] intro.1: Revise language Jeremy Baxter
2024-03-17 8:08 ` [PATCH v2 2/6] intro.1: Document the meaning of the PS1 variable Jeremy Baxter
2024-03-17 15:00 ` Alejandro Colomar
2024-03-18 19:52 ` Jeremy Baxter
2024-03-17 8:08 ` [PATCH v2 3/6] intro.1: Explain the meaning of a directory Jeremy Baxter
2024-03-17 15:05 ` Alejandro Colomar
2024-03-18 19:57 ` Jeremy Baxter
2024-03-18 21:57 ` Alejandro Colomar
2024-03-18 22:28 ` Jeremy Baxter
2024-03-17 8:08 ` [PATCH v2 4/6] intro.1: Demonstrate special cases of the cd command Jeremy Baxter
2024-03-17 15:07 ` Alejandro Colomar
2024-03-17 8:08 ` [PATCH v2 5/6] intro.1: Define a process ID Jeremy Baxter
2024-03-17 8:08 ` [PATCH v2 6/6] intro.1: Revise paragraph documenting GNU texinfo Jeremy Baxter
2024-03-17 15:10 ` Alejandro Colomar
2024-03-17 14:47 ` [PATCH v2 1/6] intro.1: Revise language Alejandro Colomar
2024-03-18 19:50 ` Jeremy Baxter
2024-03-18 19:56 ` G. Branden Robinson
2024-03-18 22:05 ` Alejandro Colomar [this message]
2024-03-18 22:32 ` Jeremy Baxter
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=Zfi6lSKPCBTiuxVg@debian \
--to=alx@kernel.org \
--cc=g.branden.robinson@gmail.com \
--cc=jtbx@disroot.org \
--cc=linux-man@vger.kernel.org \
/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.
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 NNTP newsgroup(s).