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

[DOC] Add note about int eq labels in math directive #720

Merged
merged 3 commits into from
Jun 18, 2020

Conversation

najuzilu
Copy link
Contributor

This PR adds a note directive with information that integer math labels cannot be referenced. This could be helpful to LaTeX users who are used to integer equation labels and references.

@choldgraf
Copy link
Collaborator

choldgraf commented Jun 18, 2020

Does this only apply to labels that are only integers? Or labels that also include integers? (e.g. would eq1 work?)

@najuzilu
Copy link
Contributor Author

Only labels that are integers or start with an integer (e.g. 1eq doesn't work either). The second follows from the first but it might not be intuitive for other users. If you think we should specify, I can update to this

Integer equation labels and labels which start with an integer cannot be referenced and
will throw a warning message if referenced. For example, :label: 1 and :label: 1eq cannot
be referenced.

@choldgraf
Copy link
Collaborator

Your suggested text there looks great 👍

Co-authored-by: Chris Holdgraf <[email protected]>
@choldgraf choldgraf merged commit 485e800 into jupyter-book:master Jun 18, 2020
@choldgraf
Copy link
Collaborator

Thanks!!

@choldgraf choldgraf added the documentation Something related to the documentation label Jul 28, 2020
@najuzilu najuzilu deleted the eq-label-doc branch August 26, 2020 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants