bug-bash
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Minor mistake in Bash manual


From: Todd Lehman
Subject: Re: Minor mistake in Bash manual
Date: Mon, 11 Mar 2019 22:08:47 -0500 (CDT)
User-agent: Alpine 2.21 (OSX 202 2017-01-01)

On Tue, 12 Mar 2019, Robert Elz wrote:
 | The period (".") after "name" should not be there.

Yet, the rules of grammar say it must be, as that is the end of the
sentence.

Ah. Maybe my initial e-mail wasn't clear. The second line is was actual code sample. It's formatted as verbatim, monospace text. (Have a look at the final document and you'll see what I mean. :-)

Also, if you look a few lines higher, you'll see this:

| An indexed array is created automatically if any variable is assigned to | using the syntax
| name[subscript]=value

Where there is no period after the "name[subscript]=value". So there is precendent to not use a period.

The usual solution is to rewrite the sentence so that the code/example is
not at the end, in this case perhaps something like:

        The command:
                declare -A name
        is used to create an associative array.

That would be fine with me. Just be aware that the current presentation is definitely incorrect as written. Even though English grammar rules might dictate that a period always goes at the end of a sentence, it's never appropriate to put the period inside the monospace verbatim text that the user is supposed to type.

Trust me, just have a look at the final produced document (HTML or PDF) and you'll see what I mean! :-D

Thanks,
--Todd



reply via email to

[Prev in Thread] Current Thread [Next in Thread]