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

Improve sphinx markup, guided by git grep '\\[*]' src/sage #35496

Closed
mkoeppe opened this issue Apr 13, 2023 · 0 comments · Fixed by #35537
Closed

Improve sphinx markup, guided by git grep '\\[*]' src/sage #35496

mkoeppe opened this issue Apr 13, 2023 · 0 comments · Fixed by #35537
Labels
c: documentation good first issue
Milestone
sage-10.2

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented Apr 13, 2023

This command finds lines (in docstrings) such as

src/sage/categories/crystals.py:            where c\*a2 = a3 = 2\*a4 =0 and a1=0, with c=2 for B2, c=1 for C2.
src/sage/combinat/cartesian_product.py:        Return a random element from the Cartesian product of \*iters.

\* is a sphinx-escaped *. Most (if not all) uses of it should either be replaced by math markup (`c*a_2 = a_3 = 2*a_4 =0`) or code markup (``*iters``).

Files where matches are found likely also contain other opportunities for sphinx markup improvements.
@xuluze xuluze mentioned this issue Apr 18, 2023
Merged
5 tasks
vbraun pushed a commit to vbraun/sage that referenced this issue Sep 25, 2023
sagemathgh-35537: Fix Sphinx markup in some file
bd58ad4 
    
<!-- 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 sagemath#12345", use "Add a new method to
multiply two integers" -->

### 📚 Description

<!-- Describe your changes here in detail. -->
Math equations should be marked in the math environment. Change the
Sphinx markup in src/sage/categories/crystals.py
<!-- Why is this change required? What problem does it solve? -->
Fix some Sphinx markup as posted in Issue sagemath#35496
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
Fixes sagemath#35496
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[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.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->
- sagemath#35536: branch is on top of this PR to fix a build issue in conda

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#35537
Reported by: xuluze
Reviewer(s):
@vbraun vbraun closed this as completed in 2829cf2 Sep 27, 2023
@mkoeppe mkoeppe added this to the sage-10.2 milestone Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: documentation good first issue
Projects
None yet
Milestone
sage-10.2
Development

Successfully merging a pull request may close this issue.

Fix Sphinx markup in some file xuluze/sage
1 participant
@mkoeppe