Minor documentation formatting improvement #40587
Merged
Conversation
This file contains hidden or 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 33c1f75; changes) is ready! 🎉 |
tobiasdiez
approved these changes
Aug 15, 2025
user202729
force-pushed
the
doc-formatting
branch
from
9af9f7a to
fcdda0b
Compare
Contributor
Author
|
well, the rendering is actually incorrect. https://doc-pr-40587--sagemath.netlify.app/html/en/reference/documentation/sage_docbuild/builders#hunk1 I forgot the trailing should be fixed now, but I figure it's probably a better idea for me to double check later just in case. (also there's already a |
tobiasdiez
approved these changes
Sep 11, 2025
Contributor
tobiasdiez
left a comment
tobiasdiez
left a comment
There was a problem hiding this comment.
From my side this looks good. Feel free to set it to positive review (perhaps after double checking that it renders properly after the latest merge)
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 16, 2025
sagemathgh-40587: Minor documentation formatting improvement And redirect readers to the page. I think developers are most likely to want to build the documentation. I think we should ignore the test-new failure, which is likely an oversight introduced in sagemath#39641 . As long as the corresponding test pass in test-long it should be fine. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] 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: ... --> URL: sagemath#40587 Reported by: user202729 Reviewer(s): Tobias Diez
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
And redirect readers to the page. I think developers are most likely to want to build the documentation.
I think we should ignore the test-new failure, which is likely an oversight introduced in #39641 . As long as the corresponding test pass in test-long it should be fine.
📝 Checklist
⌛ Dependencies