Remove \xspace #1439

jensmaurer · 2017-02-07T10:28:57Z

This removes lots of kerning ugliness when (e.g.) a \grammarterm is followed by a punctuator. It's also a surprise to notice all the places where we actually had superfluous whitespace in the document.

godbyk · 2017-02-07T23:36:29Z

source/macros.tex

-\newcommand{\CppXIV}{\Cpp 2014\xspace}
-\newcommand{\opt}{{\ensuremath{_\mathit{opt}}}\xspace}
+\newcommand{\Cpp}{\texorpdfstring{C\kern-0.05em\protect\raisebox{.35ex}{\textsmaller[2]{+\kern-0.05em+}}}{C++}}
+\newcommand{\CppIII}{\Cpp{} 2003}


You might also consider \Cpp~2003 if you want to keep 'C++ 2013' from splitting across two lines.

Good idea. Applied.

jensmaurer · 2017-02-08T08:00:50Z

I have run "diffpdf" in "Words" mode (to show any egregious accidents), and other than pagination changes, only substantial whitespace improvements showed up. We sometimes had inter-word space between an italics term and a subsequent comma, for example.

Overfull hboxes have improved slightly in severity (maybe because of additional kerning), but have not changed in number. Ah, I've fixed one in [alg.merge] that popped up.

The index has also improved, because two separate entries for new-expression got merged into one.

jensmaurer · 2017-02-15T19:03:22Z

Rebased.

Eelis · 2017-02-24T12:07:30Z

This is really great! (Needs another rebase though)

jensmaurer · 2017-02-27T05:44:00Z

Rebased.

tkoeppe · 2017-03-02T17:50:23Z

Note that if there are genuine errors in the current text that you discovered as part of the change, I am sympathetic towards fixing those separately in advance of this change. No need to ship a standard with known warts.

jensmaurer · 2017-03-02T18:01:35Z

@tkoeppe : Do you consider my pictures above "errors"?

tkoeppe · 2017-03-02T18:12:00Z

@jensmaurer: Yes, definitely, things like the space in "linkage ," is definitely something I'd consider borderline broken.

jensmaurer · 2017-03-02T18:26:03Z

Rebased.

Eelis · 2017-03-15T23:06:59Z

source/iostreams.tex

-\grammarterm{root-name\opt},
-\grammarterm{root-directory\opt},
+\grammarterm{\opt{root-name}},
+\grammarterm{\opt{root-directory}},


Shouldn't the \opt go outside the \grammarterm?

Yes, I believe it should. I see other places where grammarterm has problems as well, as can be seen in this grep:

$grep "grammarterm.*\<opt\>" *.tex declarations.tex:\tcode{typename}\opt{} \grammarterm{nested-name-specifier}\opt{} \grammarterm{template-name} declarations.tex:``\tcode{enum} \grammarterm{nested-name-specifier\opt} \grammarterm{identifier}'' declarations.tex:\grammarterm{attribute-specifier-seq\opt} \grammarterm{identifier}~(\ref{dcl.type.elab}), or declarators.tex:is of the form \grammarterm{attribute-specifier-seq\opt} declarators.tex:\grammarterm{attribute-specifier-seq\opt} declarators.tex:\grammarterm{cv-qualifier-seq\opt} \grammarterm{ref-qualifier\opt} declarators.tex:\grammarterm{cv-qualifier-seq}\opt \grammarterm{ref-qualifier}\opt expressions.tex:parameter-type-list \cvqual{cv} \grammarterm{ref-qualifier\opt} returning \tcode{T}'', then iostreams.tex:\grammarterm{root-name\opt}, iostreams.tex:\grammarterm{root-directory\opt},

Another editorial issue?

fwiw, I think the above should instead be coded as:

\grammarterm{root-name}\opt{}, \grammarterm{root-directory}\opt{},

@burblebee: It's an express change in this patch series to switch from blah\opt{} to \opt{blah}, because it makes it less likely to get a spacing accident by forgetting the empty {}.

tkoeppe · 2017-03-16T02:54:47Z

In the meantime, I'm sending out #1544 to just address the appalling spacing issues in basic.link.

jensmaurer · 2017-03-24T23:21:24Z

Rebased (again).

Eelis · 2017-03-28T21:22:50Z

Another bad xspace space that might be worth fixing asap is the one resulting from the use of \term in

https://github.com/cplusplus/draft/blob/master/source/expressions.tex#L4831

In C++98, there was no space there.

tkoeppe · 2017-03-29T00:53:35Z

@Eelis: Fixed by 8d3cba2, thanks.

Eelis · 2017-07-15T22:09:29Z

Perhaps now would be a good time to rebase/apply this?

jensmaurer · 2017-07-17T00:31:54Z

Rebased.

tkoeppe · 2017-07-31T15:40:03Z

Rebase, Dr Freeman.

Other than positively influencing kerning, this removal has no effect.

This was machine-converted using sed -i 's/$[-a-z]\{1,\}$\opt{}/\opt{\1}/g' *.tex sed -i 's/::\opt{}/\opt{::}/g' *.tex sed -i 's/$\terminal{[^}]*}$\opt{}/\opt{\1}/g' *.tex

…unning text This avoids colons in running text and some bad spacing.

Fixes cplusplus#1433.

to avoid an overfull hbox.

This avoids linebreaks in an unpleaseant location.

Eelis · 2017-08-06T13:35:30Z

It was mentioned on the mailing list that it would be desirable to have the new \opt reject empty arguments or arguments containing spaces. I'm a LaTeX noob, but the following seems to work:

\documentclass{article}
\usepackage{xstring}
\usepackage{ifthen}
\begin{document}
\newcommand{\opt}[1]{\IfSubStr{#1}{ }
  {\PackageError{main}{argument must not contain spaces}{}}
  {\ifthenelse{\equal{#1}{}}
    {\PackageError{main}{argument must not be empty}{}}
    {#1\ensuremath{_\mathit{opt}}}}}

hello \opt{world}
% \opt{hello world} % emits the first error
% hello world\opt{} % emits the second error
\end{document}

tkoeppe · 2017-08-06T14:31:31Z

Nice. Can you also make it discover linebreaks?

Eelis · 2017-08-06T15:30:42Z

The IfSubStr already recognizes newlines as spaces, it seems. :)

jensmaurer · 2017-08-08T17:22:19Z

Do we want to apply this patch series as large as it is, or should I split it into separate patches along the lines of:

change \Cpp and friends to \Cpp{} and remove \xspace use
change NTBS macros to \blah{} and remove \xspace use
morph blah\opt into \opt{blah} (with Eelis' macro above)

These could be reviewed separately, making smaller chunks of changes. Opinions?

tkoeppe · 2017-10-16T21:28:11Z

Is this PR redundant in light of #1761?

jensmaurer · 2017-10-17T17:28:30Z

@tkoeppe: Yes and no. #1761 removes \xspace everywhere except for \opt, which needs special treatment (to be done later). I'll close this pull request.

jensmaurer requested a review from zygoloid February 7, 2017 10:31

godbyk reviewed Feb 7, 2017

View reviewed changes

jensmaurer force-pushed the xspace branch from 1ff15d8 to b3ff5da Compare February 8, 2017 07:58

jensmaurer assigned zygoloid Feb 8, 2017

jensmaurer force-pushed the xspace branch 2 times, most recently from 6b2cea8 to 94a63fe Compare February 15, 2017 19:03

jensmaurer force-pushed the xspace branch from 94a63fe to 6a8c68d Compare February 27, 2017 05:43

jensmaurer added this to the C++20 milestone Mar 2, 2017

jensmaurer force-pushed the xspace branch from 6a8c68d to 3c6f271 Compare March 2, 2017 18:24

Eelis reviewed Mar 15, 2017

View reviewed changes

tkoeppe mentioned this pull request Mar 20, 2017

"opt" should not be italicised #1556

Closed

tkoeppe force-pushed the master branch from 305fa75 to 1af1226 Compare March 21, 2017 01:46

jensmaurer force-pushed the xspace branch from 3c6f271 to 468dcdb Compare March 24, 2017 23:20

tkoeppe force-pushed the master branch from bfc1be3 to c92319d Compare June 18, 2017 15:57

jensmaurer force-pushed the xspace branch from 468dcdb to bf852e3 Compare July 17, 2017 00:31

jensmaurer force-pushed the xspace branch from bf852e3 to a281de4 Compare July 25, 2017 20:11

jensmaurer force-pushed the xspace branch 3 times, most recently from 611571d to 91a1ef5 Compare July 28, 2017 08:08

jensmaurer added 15 commits August 1, 2017 19:41

[macros] Remove \xspace from macros taking a mandatory argument.

4a90d19

Other than positively influencing kerning, this removal has no effect.

Replace \Cpp and related macros with \Cpp{} etc.

06da2da

[macros] remove \xspace from \NTS

e2389f5

Replace \ntbs with \ntbs{} and \ntmbs with \ntmbs{}

976e52e

Replace \opt with \opt{}

ea148fc

[macros] Remove \xspace from \opt

ad88795

Use \opt{arg} instead of suffix \opt{}

d9cbb1c

This was machine-converted using sed -i 's/$[-a-z]\{1,\}$\opt{}/\opt{\1}/g' *.tex sed -i 's/::\opt{}/\opt{::}/g' *.tex sed -i 's/$\terminal{[^}]*}$\opt{}/\opt{\1}/g' *.tex

manual fixes for \opt{} removal

fd8b842

More manual fixes for \opt-as-suffix removal

1f32462

[rand] Remove non-macro use of \xspace

bc092f3

[structure.specifications] Do not use library description macros in r…

af13841

…unning text This avoids colons in running text and some bad spacing.

[macros] Replace \xspace with \space in library description macros

9fdc23b

[std] Remove unused package 'xspace'

90f875b

Fixes cplusplus#1433.

[alg.merge] Add a linebreak hint

17ad167

to avoid an overfull hbox.

[macros] For references to earlier revisions of C++, use \Cpp~2003 etc.

b4607c7

This avoids linebreaks in an unpleaseant location.

jensmaurer force-pushed the xspace branch from 91a1ef5 to b4607c7 Compare August 1, 2017 21:19

tkoeppe force-pushed the master branch from dbd84ed to 019fc86 Compare September 28, 2017 21:52

jensmaurer closed this Oct 17, 2017

jensmaurer deleted the xspace branch October 17, 2017 17:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove \xspace #1439

Remove \xspace #1439

jensmaurer commented Feb 7, 2017 •

edited

godbyk Feb 7, 2017

jensmaurer Feb 8, 2017

jensmaurer commented Feb 8, 2017 •

edited

jensmaurer commented Feb 15, 2017

Eelis commented Feb 24, 2017 •

edited

jensmaurer commented Feb 27, 2017

tkoeppe commented Mar 2, 2017

jensmaurer commented Mar 2, 2017

tkoeppe commented Mar 2, 2017

jensmaurer commented Mar 2, 2017

Eelis Mar 15, 2017

burblebee Mar 16, 2017

jensmaurer Mar 24, 2017

tkoeppe commented Mar 16, 2017

jensmaurer commented Mar 24, 2017

Eelis commented Mar 28, 2017 •

edited

tkoeppe commented Mar 29, 2017

Eelis commented Jul 15, 2017

jensmaurer commented Jul 17, 2017

tkoeppe commented Jul 31, 2017

Eelis commented Aug 6, 2017

tkoeppe commented Aug 6, 2017

Eelis commented Aug 6, 2017

jensmaurer commented Aug 8, 2017

tkoeppe commented Oct 16, 2017

jensmaurer commented Oct 17, 2017

Remove \xspace #1439

Remove \xspace #1439

Conversation

jensmaurer commented Feb 7, 2017 • edited

godbyk Feb 7, 2017

Choose a reason for hiding this comment

jensmaurer Feb 8, 2017

Choose a reason for hiding this comment

jensmaurer commented Feb 8, 2017 • edited

jensmaurer commented Feb 15, 2017

Eelis commented Feb 24, 2017 • edited

jensmaurer commented Feb 27, 2017

tkoeppe commented Mar 2, 2017

jensmaurer commented Mar 2, 2017

tkoeppe commented Mar 2, 2017

jensmaurer commented Mar 2, 2017

Eelis Mar 15, 2017

Choose a reason for hiding this comment

burblebee Mar 16, 2017

Choose a reason for hiding this comment

jensmaurer Mar 24, 2017

Choose a reason for hiding this comment

tkoeppe commented Mar 16, 2017

jensmaurer commented Mar 24, 2017

Eelis commented Mar 28, 2017 • edited

tkoeppe commented Mar 29, 2017

Eelis commented Jul 15, 2017

jensmaurer commented Jul 17, 2017

tkoeppe commented Jul 31, 2017

Eelis commented Aug 6, 2017

tkoeppe commented Aug 6, 2017

Eelis commented Aug 6, 2017

jensmaurer commented Aug 8, 2017

tkoeppe commented Oct 16, 2017

jensmaurer commented Oct 17, 2017

jensmaurer commented Feb 7, 2017 •

edited

jensmaurer commented Feb 8, 2017 •

edited

Eelis commented Feb 24, 2017 •

edited

Eelis commented Mar 28, 2017 •

edited