Skip to content

docs: Fix formatting in router/scheduler.rst#27303

Merged
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-router-scheduler
Mar 11, 2026
Merged

docs: Fix formatting in router/scheduler.rst#27303
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-router-scheduler

Conversation

@steveburnett
Copy link
Copy Markdown
Contributor

@steveburnett steveburnett commented Mar 10, 2026

Description

The formatting in router/scheduler.rst could be improved to make more sense visually.

Because the algorithms are listed as unordered list items they are indented, but the text about that algorithm is unindented and flush left. See screenshot.
Screenshot 2026-03-10 at 11 06 57 AM

This PR indents the text about each list item to fall within it to improve readability. A couple of small text edits have also been made for clarity.

Motivation and Context

Improves readability.

Impact

Documentation.

Test Plan

Local doc builds.

For the "before" state, see the screenshot above.

After:
Screenshot 2026-03-10 at 11 07 28 AM

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 ==

Summary by Sourcery

Documentation:

  • Reformat the scheduler algorithm list to indent explanatory text under each item and apply minor wording clarifications.

@steveburnett steveburnett self-assigned this Mar 10, 2026
@steveburnett steveburnett requested review from a team and elharo as code owners March 10, 2026 15:17
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Mar 10, 2026
@prestodb-ci prestodb-ci requested review from a team, jp-sivaprasad and pramodsatya and removed request for a team March 10, 2026 15:17
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Mar 10, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adjusts the documentation formatting and wording in router/scheduler.rst so that algorithm descriptions are visually nested under their list items and clarifies some explanatory text.

File-Level Changes

Change Details Files
Indent algorithm descriptions under their corresponding list items to fix list formatting in the router scheduler docs.
  • Adjust paragraph indentation so descriptive text is nested within the related bullet items in the algorithms list
  • Ensure reStructuredText list and paragraph spacing conforms to Sphinx formatting conventions for proper visual nesting
presto-docs/src/main/sphinx/router/scheduler.rst
Polish and clarify textual explanations in the router scheduler documentation.
  • Rephrase a few sentences for clarity and readability in the algorithm descriptions
  • Tighten wording without changing the technical meaning of the documentation
presto-docs/src/main/sphinx/router/scheduler.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

@github-project-automation github-project-automation bot moved this to 🆕 Unprioritized in Presto Documentation Mar 10, 2026
@steveburnett steveburnett moved this from 🆕 Unprioritized to 👀 Review in Presto Documentation Mar 10, 2026
Copy link
Copy Markdown
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 - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="presto-docs/src/main/sphinx/router/scheduler.rst" line_range="25" />
<code_context>

 * ``USER_HASH``

-Selecting a clusters by hashing the username. This ensures queries from the same
-user will always be routed to the same cluster.
+  Selecting a clusters by hashing the username. This ensures queries from the same 
</code_context>
<issue_to_address>
**issue (typo):** Fix grammatical error in "Selecting a clusters" phrase.

Please update the phrase to either "Selecting a cluster by hashing the username" or "Selecting clusters by hashing the username" to fix the grammar.

```suggestion
  Selecting a cluster by hashing the username. This ensures queries from the same 
```
</issue_to_address>

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.

@steveburnett steveburnett force-pushed the steveburnett-router-scheduler branch from 51d2c56 to 935fe5d Compare March 10, 2026 15:20
Copy link
Copy Markdown
Contributor

@pramodsatya pramodsatya left a comment

Choose a reason for hiding this comment

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

Thanks for the fix @steveburnett.

Copy link
Copy Markdown
Member

@hantangwangd hantangwangd left a comment

Choose a reason for hiding this comment

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

Thanks @steveburnett, lgtm!

@github-project-automation github-project-automation bot moved this from 👀 Review to ✅ Done in Presto Documentation Mar 11, 2026
@steveburnett steveburnett merged commit 06ca23e into prestodb:master Mar 11, 2026
84 of 87 checks passed
@steveburnett steveburnett deleted the steveburnett-router-scheduler branch March 11, 2026 16:48
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