Skip to content

Conversation

@steveburnett
Copy link
Contributor

Description

Fix formatting errors in

presto/presto-docs/src/main/sphinx/presto_cpp/properties-session.rst
presto/presto-docs/src/main/sphinx/sql/drop-materialized-view.rst
presto/presto-docs/src/main/sphinx/sql/refresh-materialized-view.rst
presto-docs/src/main/sphinx/sql/show-create-materialized-view.rst

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:

/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/presto_cpp/properties-session.rst:515: WARNING: Title underline too short.

``native_max_split_preload_per_driver``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [docutils]
/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/presto_cpp/properties-session.rst:515: WARNING: Title underline too short.

``native_max_split_preload_per_driver``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [docutils]
/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/sql/refresh-materialized-view.rst:1: WARNING: Title overline too short.

========================
REFRESH MATERIALIZED VIEW
======================== [docutils]
/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/sql/show-create-materialized-view.rst:1: WARNING: Title overline too short.

============================
SHOW CREATE MATERIALIZED VIEW
============================ [docutils]
/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/sql/drop-materialized-view.rst:1: WARNING: Title overline too short.

=====================
DROP MATERIALIZED VIEW
===================== [docutils]


/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/sql/refresh-materialized-view.rst:1: WARNING: Title overline too short.

========================
REFRESH MATERIALIZED VIEW
======================== [docutils]

and the total was

build succeeded, 53 warnings.

After the fixes, none of these warnings are displayed in a local doc build. The total is

build succeeded, 48 warnings.

Contributor checklist

  • Please make sure your submission complies with our contributing guide, in particular code style and commit standards.
  • 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.
  • If adding new dependencies, verified they have an OpenSSF Scorecard score of 5.0 or higher (or obtained explicit TSC approval for lower scores).

Release Notes

== NO RELEASE NOTE ==

@steveburnett steveburnett self-assigned this Nov 20, 2025
@steveburnett steveburnett requested review from a team and elharo as code owners November 20, 2025 20:39
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Nov 20, 2025
@github-project-automation github-project-automation bot moved this to 🆕 Unprioritized in Presto Documentation Nov 20, 2025
@prestodb-ci prestodb-ci requested review from a team, bibith4 and wanglinsong and removed request for a team November 20, 2025 20:40
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 20, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This 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

Change Details Files
Fix title underline lengths in properties-session.rst
  • Adjusted underline length to match the code title 'native_max_split_preload_per_driver'
  • Removed duplicate warning-triggering title block
presto-docs/src/main/sphinx/presto_cpp/properties-session.rst
Correct SQL command title decorations
  • Extended overlines/underlines to match 'REFRESH MATERIALIZED VIEW' length
  • Extended overlines/underlines to match 'SHOW CREATE MATERIALIZED VIEW' length
  • Extended overlines/underlines to match 'DROP MATERIALIZED VIEW' length
presto-docs/src/main/sphinx/sql/refresh-materialized-view.rst
presto-docs/src/main/sphinx/sql/show-create-materialized-view.rst
presto-docs/src/main/sphinx/sql/drop-materialized-view.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@steveburnett steveburnett moved this from 🆕 Unprioritized to 👀 Review in Presto Documentation Nov 20, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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!

@github-project-automation github-project-automation bot moved this from 👀 Review to ✅ Done in Presto Documentation Nov 21, 2025
@tdcmeehan tdcmeehan merged commit 7aed5f2 into prestodb:master Nov 21, 2025
79 checks passed
@steveburnett steveburnett deleted the steveburnett-formatting-cpp branch November 21, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs from:IBM PR from IBM

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants