Skip to content

fix(docs): Fix spilling docs#26194

Merged
pratyakshsharma merged 1 commit intoprestodb:masterfrom
pratyakshsharma:spill-docs-fix
Jan 21, 2026
Merged

fix(docs): Fix spilling docs#26194
pratyakshsharma merged 1 commit intoprestodb:masterfrom
pratyakshsharma:spill-docs-fix

Conversation

@pratyakshsharma
Copy link
Copy Markdown
Contributor

Description

Fix spilling related docs

Motivation and Context

User facing docs related to spilling were out of date till now and had a typo. This PR fixes them.

Impact

NA

Test Plan

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.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== NO RELEASE NOTE ==

@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Sep 30, 2025
@prestodb-ci prestodb-ci requested review from a team, Joe-Abraham and ShahimSharafudeen and removed request for a team September 30, 2025 18:34
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Sep 30, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documentation for spilling has been updated to correct a typo, refresh session and admin property descriptions, align defaults with code, and improve clarity.

File-Level Changes

Change Details Files
Fix typo and formatting in the standalone spilling guide
  • Correct misspelling of “spilling”
  • Adjust heading style to match conventions
  • Fix minor grammatical errors
presto-docs/src/main/sphinx/admin/spill.rst
Update session property docs related to spilling
  • Revise descriptions for spill thresholds
  • Align default values with current implementation
  • Improve example formatting
presto-docs/src/main/sphinx/admin/properties-session.rst
Refresh admin properties page for spilling configurations
  • Clarify units and limits for spill properties
  • Update examples to reflect behavior changes
  • Remove outdated notes and references
presto-docs/src/main/sphinx/admin/properties.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

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 there - I've reviewed your changes and they look great!

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

## Individual Comments

### Comment 1
<location> `presto-docs/src/main/sphinx/admin/properties-session.rst:150-151` </location>
<code_context>
-footprint to pass at the cost of slower execution times. Currently, spilling is supported only for
-aggregations and joins (inner and outer), so this property will not reduce memory usage required for
-window functions, sorting and other join types.
+footprint to pass at the cost of slower execution times. See :ref:`spill-operations`
+for list of operations that support spilling.

 Be aware that this is an experimental feature and should be used with care.
</code_context>

<issue_to_address>
**suggestion (typo):** Add 'a' before 'list' for grammatical correctness.

Change to 'for a list of operations that support spilling.' for correct grammar.

```suggestion
footprint to pass at the cost of slower execution times. See :ref:`spill-operations`
for a list of operations that support spilling.
```
</issue_to_address>

### Comment 2
<location> `presto-docs/src/main/sphinx/admin/properties.rst:255-256` </location>
<code_context>
-footprint to pass at the cost of slower execution times. Currently, spilling is supported only for
-aggregations and joins (inner and outer), so this property will not reduce memory usage required for
-window functions, sorting and other join types.
+footprint to pass at the cost of slower execution times. See :ref:`spill-operations`
+for list of operations that support spilling.

 Be aware that this is an experimental feature and should be used with care.
</code_context>

<issue_to_address>
**suggestion (typo):** Add 'a' before 'list' for grammatical correctness.

Change to 'for a list of operations that support spilling.' for correct grammar.

```suggestion
footprint to pass at the cost of slower execution times. See :ref:`spill-operations`
for a list of operations that support spilling.
```
</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.

Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

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

Please fix the two grammar nits that sourcery-ai commented on. I don't find anything else that needs fixing.

Pull branch, local doc build, review all three pages' changes as built locally.

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to 🏗 In progress in Presto Documentation Sep 30, 2025
@pratyakshsharma
Copy link
Copy Markdown
Contributor Author

@steveburnett please check again.

steveburnett
steveburnett previously approved these changes Oct 1, 2025
Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

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

LGTM! (docs)

Pull updated branch, new local doc build, looks good. Thanks!

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Presto Documentation Oct 1, 2025
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 for the fix! LGTM overall, just have one little point for a quick discussion.

@tdcmeehan tdcmeehan changed the title Fix spilling docs fix(docs): Fix spilling docs Oct 2, 2025
@pratyakshsharma
Copy link
Copy Markdown
Contributor Author

@steveburnett @hantangwangd can you both please take a pass again?

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 @pratyakshsharma, lgtm!

Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

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

LGTM! (docs)

Pull branch, local doc build, looks good. Thanks!

@pratyakshsharma pratyakshsharma merged commit 5a28e1c into prestodb:master Jan 21, 2026
78 checks passed
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.

6 participants