Fix LaTeX output of FreeModuleTensor.display_comp #37823
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Documentation preview for this PR (built with commit 6874f7d; changes) is ready! 🎉 |
mkoeppe
approved these changes
Apr 17, 2024
|
Thank you for the review! |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Apr 28, 2024
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [x] I have created tests covering the changes. - [x] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> None. This PR fixes an issue of the method `display_comp` of class `FreeModuleTensor`, which arises when the LaTeX name of a tensor contains the symbol `^` or `_`. For instance, in Sage 10.4.beta3, we have: ``` sage: E.<x,y> = EuclideanSpace() sage: g = E.metric() sage: latex(g.inverse().display_comp()) \begin{array}{lcl} g^{-1}_{\phantom{\, x}\phantom{\, x}}^{ \, x \, x } & = & 1 \\ g^{-1}_{\phantom{\, y}\phantom{\, y}}^{ \, y \, y } & = & 1 \end{array} ``` This is incorrect LaTeX syntax: the symbol `g` gets two exponent markers (`^`). Consequently, in a Jupyter notebook in `%display latex` mode, the command `g.inverse().display_comp()` will not generate any typeset output. This is fixed here by making the LaTeX output of `display_comp` more robust: the LaTeX symbol of the tensor (`g^{-1}` in the above example) is now enclosed between two braces (e.g. `g^{-1}` is changed into `{g^{-1}}`) before adding indices to it. URL: sagemath#37823 Reported by: Eric Gourgoulhon Reviewer(s): Matthias Köppe
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Checklist
⌛ Dependencies
None.
This PR fixes an issue of the method
display_compof classFreeModuleTensor, which arises when the LaTeX name of a tensor contains the symbol^or_. For instance, in Sage 10.4.beta3, we have:This is incorrect LaTeX syntax: the symbol
ggets two exponent markers (^). Consequently, in a Jupyter notebook in%display latexmode, the commandg.inverse().display_comp()will not generate any typeset output.This is fixed here by making the LaTeX output of
display_compmore robust: the LaTeX symbol of the tensor (g^{-1}in the above example) is now enclosed between two braces (e.g.g^{-1}is changed into{g^{-1}}) before adding indices to it.