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.

Sign up for GitHub

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

Jump to bottom

Formatting error in docstring of matrix_modn_dense_float.pyx #35363

Closed
crnsh opened this issue Mar 27, 2023 · 0 comments · Fixed by #35382
Closed

Formatting error in docstring of matrix_modn_dense_float.pyx #35363

crnsh opened this issue Mar 27, 2023 · 0 comments · Fixed by #35382
Milestone
sage-10.0

Comments

@crnsh
Copy link
Contributor

crnsh commented Mar 27, 2023

In the docstring of class Matrix_modn_dense_float in file matrix_modn_dense_float.pyx on line 55, the matrix_modn_dense_template.pxi only has single backtick which is causing it to incorrectly render in LaTeX on the wiki.

image

This is my first raised issue and I'd like to solve it in order to get familiar with the Sage contribution procedure.
@crnsh crnsh mentioned this issue Mar 29, 2023
Merged
5 tasks
vbraun pushed a commit that referenced this issue Apr 6, 2023
gh-35382: Add missing backticks to correct formatting
34b6383 
    
<!-- Please provide a concise, informative and self-explanatory title.
-->
<!-- Don't put issue numbers in the title. Put it in the Description
below. -->
<!-- For example, instead of "Fixes #12345", use "Add a new method to
multiply two integers" -->

### 📚 Description

<!-- Describe your changes here in detail. -->
<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes #12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->
`matrix_modn_dense_float.pyx` had single backticks in one of the
docstrings which was causing it to render as LaTeX text, while it was
intended to be monospace formatted. The missing backticks are added to
fix this.

Fixes #35363

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[x
]`. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- #12345: short description why this is a dependency
- #34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: #35382
Reported by: Karan Handa
Reviewer(s): Matthias Köppe
@mkoeppe mkoeppe added this to the sage-10.0 milestone Apr 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
sage-10.0
Development

Successfully merging a pull request may close this issue.

Add missing backticks to correct formatting crnsh/sage
2 participants
@mkoeppe @crnsh