Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of \ShowCommand #1458

Open
Rimole opened this issue Sep 6, 2024 · 3 comments
Open

Documentation of \ShowCommand #1458

Rimole opened this issue Sep 6, 2024 · 3 comments
Labels
bug (documentation) category base (latex) fixed in dev Fixed in development branch, not in stable release

Comments

@Rimole
Copy link

Rimole commented Sep 6, 2024

source2e.pdf, page 100, File 06: ltdefns.dtx Date: 2024/04/17 Version v1.5t, 1.5.2 Showing robust commands, \ShowCommand, second sentence:
"the command’s is detected to has a given type of robustness"
That does not sound like proper English.
Also, when editing there anyway: In the third sentence, please use a \newline after the colon (overfull line).
And the next command \@showcommandlisthook is printed in the margin one line too late.
Thank you!

@muzimuzhi
Copy link
Contributor

latex2e/base/ltdefns.dtx

Lines 1773 to 1777 in fc85575

% Most of the machinery defined for \cs{NewCommandCopy} can be used to show
% the definition of a robust command, in a similar fashion to \texttt{texdef}.
% The difference is that after the command's is detected to has a given type
% of robustness, rather than making a copy, we use a separate routine to show
% its definition.

Does this read better?

%   Most of the machinery defined for \cs{NewCommandCopy} can be used to show
%   the definition of a robust command, in a similar fashion to \texttt{texdef}.
-%   The difference is that after the command's is detected to has a given type
+%   The difference is that after the command is detected to has a given type
%   of robustness, rather than making a copy, we use a separate routine to show
%   its definition.

@car222222
Copy link
Contributor

Better Grammar: 😀
. . . is detected to have a given . . .

@FrankMittelbach
Copy link
Member

And the next command \@showcommandlisthook is printed in the margin one line too late.

That is something that is due to the rather fragile definitions in ltxdoc and its overwrites. Happens probably because the margin is too small in the setup for source2e. Not something I would spend time on debugging or fixing given that the class does need a rewrite anyway (one day).

The other issues have been addressed, thanks.

@FrankMittelbach FrankMittelbach added the fixed in dev Fixed in development branch, not in stable release label Sep 6, 2024
@FrankMittelbach FrankMittelbach added this to the Release 2024 Fall milestone Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug (documentation) category base (latex) fixed in dev Fixed in development branch, not in stable release
Projects
Status: Done in dev
Development

No branches or pull requests

4 participants