Skip to content

[docs] Fix header formatting in docs files#22876

Merged
tdcmeehan merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-fix-header-formatting
Jun 4, 2024
Merged

[docs] Fix header formatting in docs files#22876
tdcmeehan merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-fix-header-formatting

Conversation

@steveburnett
Copy link
Contributor

@steveburnett steveburnett commented May 30, 2024

Description

Fixed title and header formatting that produces errors during a build of the docs. I started to make a very few minor text changes, but realized that applying consistency for those text changes would a) take a lot longer and b) not reduce the number of errors in the build, so I stopped doing that.

Example error that I fixed in this PR:

/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/overview/concepts.rst:34: WARNING: Title underline too short.

Motivation and Context

These errors don't stop the build but they're annoying me and it's an easy and low-risk fix.

Impact

Local docs build, before the changes in this PR:
build succeeded, 730 warnings.

After:
build succeeded, 677 warnings.

Test Plan

Local docs build (resulting in statements in Impact. Also, CI.

Contributor checklist

  • Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

== NO RELEASE NOTE ==

@steveburnett steveburnett requested a review from a team as a code owner May 30, 2024 17:27
@steveburnett steveburnett requested a review from presto-oss May 30, 2024 17:27
@github-actions github-actions bot added the docs label May 30, 2024
Copy link
Member

@agrawalreetika agrawalreetika left a comment

Choose a reason for hiding this comment

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

Yeah, I have observed these types of warnings as well and tried to fix few in my past docs PRs.
Thanks for this PR. LGTM 👍🏻

Just checking, are we planning to suppress those existing 677 warnings as well in future PRs?

@steveburnett
Copy link
Contributor Author

Yeah, I have observed these types of warnings as well and tried to fix few in my past docs PRs. Thanks for this PR. LGTM 👍🏻

Just checking, are we planning to suppress those existing 677 warnings as well in future PRs?

Over time, yes! I'd like to get most or all the errors that cause these various warnings fixed eventually. This was a quick low-effort fix of one set of the errors, and I limited the scope of this PR to fixing Title underline too short errors in the doc builds for a simpler PR and an even simpler review process.

Copy link
Contributor

@tdcmeehan tdcmeehan left a comment

Choose a reason for hiding this comment

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

Thank you @steveburnett

@tdcmeehan tdcmeehan merged commit 3e0fad0 into prestodb:master Jun 4, 2024
@steveburnett
Copy link
Contributor Author

It appears that updating the Presto docs Sphinx theme in #22887 fixed another 24 docs build warnings: my new local docs build with that and this PR both merged results in
build succeeded, 653 warnings. down from 730. So that's nice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants