dash.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jilles Tjoelker <jilles@stack.nl>
To: Larry Hynes <larry@larryhynes.com>
Cc: dash@vger.kernel.org
Subject: Re: Small cleanup to src/dash.1 - Command Line Editing
Date: Fri, 23 Jun 2017 16:41:28 +0200	[thread overview]
Message-ID: <20170623144128.GA15837@stack.nl> (raw)
In-Reply-To: <6csf1e-9n5.ln1@sabon.larryhynes.com>

On Sat, Jun 17, 2017 at 03:53:26PM +0100, Larry Hynes wrote:
> src/dash.1, under Command Line Editing, states:

> 	It's similar to vi: typing <ESC> will throw you into command
> 	VI command mode.

> - There appears to be no need for both occurrences of 'command'
> - I can't see a reason for VI to be capitalised
> - 'will throw you into' seems a little... enthusiastic

> Following diff changes it to

> 	It's similar to vi: typing <ESC> enters vi command mode.

> diff --git a/src/dash.1 b/src/dash.1
> index 8b8026d..f35d89d 100644
> --- a/src/dash.1
> +++ b/src/dash.1
> @@ -2232,7 +2232,7 @@ enabled, sh can be switched between insert mode and command mode.
>  The editor is not described in full here, but will be in a later document.
>  It's similar to vi: typing
>  .Aq ESC
> -will throw you into command VI command mode.
> +enters vi command mode.
>  Hitting
>  .Aq return
>  while in command mode will pass the line to the shell.

I agree. If you're changing things here anyway, I suggest getting rid of
the contraction as well (changing It's to It is). The fairly formal
style of man pages avoids contractions, just like it avoids "you".

The reference to the "later document" can probably be removed as well,
since said document does not exist yet after many years.

-- 
Jilles Tjoelker

  reply	other threads:[~2017-06-23 14:50 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-17 14:53 Small cleanup to src/dash.1 - Command Line Editing Larry Hynes
2017-06-23 14:41 ` Jilles Tjoelker [this message]
2017-06-23 16:42   ` Larry Hynes

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=20170623144128.GA15837@stack.nl \
    --to=jilles@stack.nl \
    --cc=dash@vger.kernel.org \
    --cc=larry@larryhynes.com \
    /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).