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

l3doc: option about whether to expand @@ when typesetting #416

Open
wspr opened this issue Nov 22, 2017 · 3 comments
Open

l3doc: option about whether to expand @@ when typesetting #416

wspr opened this issue Nov 22, 2017 · 3 comments
Labels
enhancement New feature or request l3doc

Comments

@wspr
Copy link
Contributor

wspr commented Nov 22, 2017

After some discussion I think the team is fairly evenly split on whether @@ code should be typeset verbatim or with the module name included.

While we decide on a convention for the LaTeX3 code itself, I think it would be fair to add this as an option to l3doc itself.

@FrankMittelbach
Copy link
Member

After thinking this over I'm in favor of implementing this as an option with the default being to print @@.

  • for individual packages where you have a single module (which is outside of the kernel probably the default) that seems to be the right approach as it makes the documentation shorter and probably easier to read
  • for something like the kernel sources I guess I am still in favor of seeing the source documentation matching closely what would be in expl-code.tex and not having @@ all over the place and changing meaning every few pages of documentation .

@josephwright
Copy link
Member

I think overall we should avoid this: it's best if the typeset code is the 'live' version.

@wspr
Copy link
Contributor Author

wspr commented Apr 23, 2018 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request l3doc
Projects
No open projects
Development

No branches or pull requests

3 participants