Skip to content

Minor documentation formatting improvement #40587

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

user202729
Copy link
Contributor

@user202729 user202729 commented Aug 15, 2025

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

  • 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

Copy link

github-actions bot commented Aug 15, 2025

Documentation preview for this PR (built with commit fcdda0b; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@user202729
Copy link
Contributor Author

user202729 commented Aug 15, 2025

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 highlight:: bash at the start of the document, so that change is actually redundant.)

@user202729 user202729 requested a review from tobiasdiez August 17, 2025 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants