bug-texinfo
[Top][All Lists]
Advanced

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

Re: a sentence ending in uppercase suppresses double space


From: Gavin Smith
Subject: Re: a sentence ending in uppercase suppresses double space
Date: Fri, 7 Aug 2015 10:33:35 +0100

On 7 August 2015 at 09:31, Benno Schulenberg <address@hidden> wrote:
> The double quotes have to be shown because the user has to type them.
> It won't work without them, and other quotes won't work.

Do you think the user will know that they have to type them?

Single-quotes are a standard way to indicate sample code or input to
programs in Info files so it's likely the person reading it will
realise what they mean.

The first use in the file you linked to:

@item -Q "@var{characters}"
@itemx --quotestr="@var{characters}"
Set the quoting string for justifying.  The default value is
@t{"^([ \t]*[|>:@}#])+"} if extended regular expression support
is available, and @t{"> "} otherwise.
Note that @code{\t} stands for a literal Tab character.

This is in the context of describing command-line options.

The double quotes are in the @item line, so if the value given is
substituted for @var{characters}, two sets of double quotes will
appear.

I'd suggest that people using the shell should know what double quotes
mean to the shell and know when they should be used, so I'd guess that
the double quotes in the @item line are unnecessary.

Here's a suggestion how to change it:

@item -Q @var{characters}
@itemx address@hidden
Set the quoting string for justifying.  The default value is
@samp{^([ \t]*[|>:@}#])+} if extended regular expression support
is available, and @samp{> } otherwise. @code{\t} stands for a literal
Tab character.

If that's not enough, maybe mention that characters that the shell
treats as special need to be quoted or escaped.



reply via email to

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