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

Fix few title underlines #326

Merged
merged 1 commit into from
Feb 8, 2024
Merged

Fix few title underlines #326

merged 1 commit into from
Feb 8, 2024

Conversation

ruslo
Copy link
Contributor

@ruslo ruslo commented Feb 8, 2024

Noticed them while checking #325. Also, I realized that Sphinx can warn about underlines that are too short but ignore underlines that are too long.

@2bndy5
Copy link
Collaborator

2bndy5 commented Feb 8, 2024

I realized that Sphinx can warn about underlines that are too short but ignore underlines that are too long.

Yep. This is why we don't really care about underlines that are too long. Underlines that are too short will break our docs build in CI.

2bndy5
2bndy5 approved these changes Feb 8, 2024
View reviewed changes
Copy link
Collaborator

@2bndy5 2bndy5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm OK with these changes, but it is really an aesthetic preference of doc authors. These changes pose no difference in how the docs are parsed or rendered.

@2bndy5 2bndy5 merged commit dcbb503 into jbms:main Feb 8, 2024
70 checks passed
@ruslo ruslo deleted the pr.title branch February 8, 2024 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@2bndy5 2bndy5 2bndy5 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ruslo @2bndy5