-
Notifications
You must be signed in to change notification settings - Fork 5.5k
fix(docs): Formatting in documentation files #26667
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
fix(docs): Formatting in documentation files #26667
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR eliminates Sphinx title decoration warnings by adjusting the length of underlines and overlines in several RST documentation files so they exactly match their titles. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tdcmeehan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Description
Fix formatting errors in
Motivation and Context
Fixing errors that cause warnings and error messages in the doc build makes the docs build faster.
Impact
Documentation.
Test Plan
Before the fixes, the following warnings displayed in a local doc build:
and the total was
After the fixes, none of these warnings are displayed in a local doc build. The total is
Contributor checklist
Release Notes