Skip to content

docs: Fix minor documentation issues#26866

Merged
hantangwangd merged 1 commit intoprestodb:masterfrom
dnskr:fix-some-minor-doc-issues
Jan 9, 2026
Merged

docs: Fix minor documentation issues#26866
hantangwangd merged 1 commit intoprestodb:masterfrom
dnskr:fix-some-minor-doc-issues

Conversation

@dnskr
Copy link
Copy Markdown
Contributor

@dnskr dnskr commented Dec 27, 2025

Description

The PR fixes some minor issues in the documentation.

Motivation and Context

The following issues have been fixed:

  1. Use sql lexer for code-block instead of java.
./presto/presto-docs/src/main/sphinx/develop/procedures.rst:155: WARNING: Lexing literal_block "call iceberg.system.expire_snapshots('default', 'test_table');\ncall hive.system.invalidate_directory_list_cache();\n......" as "java" resulted in an error at token: "'". Retrying in relaxed mode. [misc.highlighting_failure]
  1. Code block http was used for shell commands.
./presto/presto-docs/src/main/sphinx/presto_cpp/features.rst:58: WARNING: Lexing literal_block 'curl -X GET "http://localhost:7777/v1/operation/server/clearCache?type=memory"\n\nCleared memory cache' as "http" resulted in an error at token: 'c'. Retrying in relaxed mode. [misc.highlighting_failure]
./presto/presto-docs/src/main/sphinx/presto_cpp/features.rst:66: WARNING: Lexing literal_block 'curl -X GET "http://localhost:7777/v1/operation/server/clearCache?type=ssd"\n\nCleared ssd cache' as "http" resulted in an error at token: 'c'. Retrying in relaxed mode. [misc.highlighting_failure]
./presto/presto-docs/src/main/sphinx/presto_cpp/features.rst:74: WARNING: Lexing literal_block 'curl -X GET "http://localhost:7777/v1/operation/server/writeSsd"\n\nSucceeded write ssd cache' as "http" resulted in an error at token: 'c'. Retrying in relaxed mode. [misc.highlighting_failure]
  1. Too short underline.
./presto/presto-docs/src/main/sphinx/plugin/native-sidecar-plugin.rst:110: WARNING: Title underline too short.

Expression optimizer
----------------- [docutils]
  1. Title underline for Materialized Views sub-section.
./presto/presto-docs/src/main/sphinx/connector/iceberg.rst:2390: CRITICAL: Title level inconsistent:

Stale Data Handling
""""""""""""""""""" [docutils]

Impact

None

Test Plan

Build documentation and check there are no related warning mentioned in the description:

presto-docs/build

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

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Dec 27, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR fixes several Sphinx/docutils warnings in the Presto documentation by correcting code block language annotations, string quoting in Java-labeled blocks, and heading underline lengths/levels so that docs build cleanly without highlighting or title-structure errors.

File-Level Changes

Change Details Files
Fix Java code block string quoting so Sphinx can lex the block without errors.
  • Update single-quoted Java string literals in a literal_block to use double-quoted strings consistent with Java syntax.
  • Ensure the java code block no longer triggers misc.highlighting_failure warnings during doc build.
presto-docs/src/main/sphinx/develop/procedures.rst
Correct language specifiers for curl command examples so they are treated as shell, not HTTP, snippets.
  • Change code block directives from http to shell (or equivalent) for curl examples.
  • Resolve misc.highlighting_failure warnings caused by misclassified curl snippets.
presto-docs/src/main/sphinx/presto_cpp/features.rst
Fix heading underline issues to satisfy docutils title rules.
  • Extend an underline under the 'Expression optimizer' heading so its length matches the heading text.
  • Adjust the underline style/level for the 'Stale Data Handling' heading under the Iceberg connector docs to be consistent with the 'Materialized Views' subsection hierarchy.
presto-docs/src/main/sphinx/plugin/native-sidecar-plugin.rst
presto-docs/src/main/sphinx/connector/iceberg.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-actions github-actions bot added the docs label Dec 27, 2025
@github-project-automation github-project-automation bot moved this to 🆕 Unprioritized in Presto Documentation Dec 27, 2025
@dnskr dnskr force-pushed the fix-some-minor-doc-issues branch from 4bfdccd to 26395c1 Compare December 27, 2025 16:42
@dnskr dnskr changed the title Fix minor documentation issues docs: Fix minor documentation issues Dec 27, 2025
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 2 issues

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

## Individual Comments

### Comment 1
<location> `presto-docs/src/main/sphinx/presto_cpp/features.rst:56` </location>
<code_context>

 * GET: /v1/operation/server/clearCache?type=memory: It clears the memory cache on worker node. Here is an example:

-  .. sourcecode:: http
</code_context>

<issue_to_address>
**suggestion (typo):** Consider adding "the" before "worker node" for grammatical correctness.

Change "It clears the memory cache on worker node." to "It clears the memory cache on the worker node." for better readability.

Suggested implementation:

```
* GET: /v1/operation/server/clearCache?type=memory: It clears the memory cache on the worker node. Here is an example:

```

```
* GET: /v1/operation/server/clearCache?type=ssd: It clears the ssd cache on the worker node. Here is an example:

```
</issue_to_address>

### Comment 2
<location> `presto-docs/src/main/sphinx/presto_cpp/features.rst:64` </location>
<code_context>

 * GET: /v1/operation/server/clearCache?type=ssd: It clears the ssd cache on worker node. Here is an example:

-  .. sourcecode:: http
</code_context>

<issue_to_address>
**suggestion (typo):** Consider capitalizing "SSD" and adding "the" before "worker node".

You could rephrase this sentence to: "It clears the SSD cache on the worker node."

```suggestion
* GET: /v1/operation/server/clearCache?type=ssd: It clears the SSD cache on the worker node. Here is an example:
```
</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.

@tdcmeehan tdcmeehan self-assigned this Dec 27, 2025
@dnskr dnskr force-pushed the fix-some-minor-doc-issues branch from 26395c1 to a46b1ae Compare December 28, 2025 11:52
@dnskr dnskr requested a review from hantangwangd December 28, 2025 14:47

Stale Data Handling
"""""""""""""""""""
^^^^^^^^^^^^^^^^^^^
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One more thing: I suspect this is intentionally meant to be a sub-level. If so, since the document previously defined ~~~~~~ as the sub-level of ^^^^^^, should we use ~~~~~~ here for level consistency? cc: @tdcmeehan

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

One more thing: I suspect this is intentionally meant to be a sub-level. If so, since the document previously defined ~~~~~~ as the sub-level of ^^^^^^, should we use ~~~~~~ here for level consistency? cc: @tdcmeehan

@hantangwangd, I think that this Stale Data Handling is a subheading of Materialized Views so I think this change is okay. On the other hand, if Stale Data Handling is intended as a subheading of Freshness and Refresh, then I would agree with you.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes, I had intended this to be a sub-heading for Materialized Views, however if we think this should go under Freshness and Refresh I am fine with that too.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Materialized Views

Thanks @tdcmeehan! This PR sets the Stale Data Handling heading as a subheading of Materialized Views. I don't see a strong reason in the text that this should be changed to be a subheading of Freshness and Refresh.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your feedback and confirmation @tdcmeehan, @steveburnett. I'm completely okey with treating it as a subheading of Materialized Views.

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.

Thanks for the doc! Just Commenting, not Approval today, until we get clarification of the Stale Data Handling heading level.


Stale Data Handling
"""""""""""""""""""
^^^^^^^^^^^^^^^^^^^
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

One more thing: I suspect this is intentionally meant to be a sub-level. If so, since the document previously defined ~~~~~~ as the sub-level of ^^^^^^, should we use ~~~~~~ here for level consistency? cc: @tdcmeehan

@hantangwangd, I think that this Stale Data Handling is a subheading of Materialized Views so I think this change is okay. On the other hand, if Stale Data Handling is intended as a subheading of Freshness and Refresh, then I would agree with you.

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.

Based on @tdcmeehan's comment, I am approving this PR.

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to ✅ Done in Presto Documentation Jan 8, 2026
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 @dnskr, lgtm!

@hantangwangd hantangwangd merged commit 9479f20 into prestodb:master Jan 9, 2026
79 of 80 checks passed
tdcmeehan pushed a commit to rdtr/presto that referenced this pull request Jan 14, 2026
## Description
The PR fixes some minor issues in the documentation.

## Motivation and Context
The following issues have been fixed:
1. Use `sql` lexer for `code-block` instead of `java`.
```
./presto/presto-docs/src/main/sphinx/develop/procedures.rst:155: WARNING: Lexing literal_block "call iceberg.system.expire_snapshots('default', 'test_table');\ncall hive.system.invalidate_directory_list_cache();\n......" as "java" resulted in an error at token: "'". Retrying in relaxed mode. [misc.highlighting_failure]
```
2. Code block `http` was used for `shell` commands.
```
./presto/presto-docs/src/main/sphinx/presto_cpp/features.rst:58: WARNING: Lexing literal_block 'curl -X GET "http://localhost:7777/v1/operation/server/clearCache?type=memory"\n\nCleared memory cache' as "http" resulted in an error at token: 'c'. Retrying in relaxed mode. [misc.highlighting_failure]
./presto/presto-docs/src/main/sphinx/presto_cpp/features.rst:66: WARNING: Lexing literal_block 'curl -X GET "http://localhost:7777/v1/operation/server/clearCache?type=ssd"\n\nCleared ssd cache' as "http" resulted in an error at token: 'c'. Retrying in relaxed mode. [misc.highlighting_failure]
./presto/presto-docs/src/main/sphinx/presto_cpp/features.rst:74: WARNING: Lexing literal_block 'curl -X GET "http://localhost:7777/v1/operation/server/writeSsd"\n\nSucceeded write ssd cache' as "http" resulted in an error at token: 'c'. Retrying in relaxed mode. [misc.highlighting_failure]
```
3. Too short underline.
```
./presto/presto-docs/src/main/sphinx/plugin/native-sidecar-plugin.rst:110: WARNING: Title underline too short.

Expression optimizer
----------------- [docutils]
```
4. Title underline for `Materialized Views` sub-section. 
```
./presto/presto-docs/src/main/sphinx/connector/iceberg.rst:2390: CRITICAL: Title level inconsistent:

Stale Data Handling
""""""""""""""""""" [docutils]

```

## Impact
`None`

## Test Plan
Build documentation and check there are no related warning mentioned in
the description:
```shell
presto-docs/build
```

## Contributor checklist

- [ ] Please make sure your submission complies with our [contributing
guide](https://github.com/prestodb/presto/blob/master/CONTRIBUTING.md),
in particular [code
style](https://github.com/prestodb/presto/blob/master/CONTRIBUTING.md#code-style)
and [commit
standards](https://github.com/prestodb/presto/blob/master/CONTRIBUTING.md#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](https://github.com/prestodb/presto/wiki/Release-Notes-Guidelines).
- [ ] Adequate tests were added if applicable.
- [ ] CI passed.
- [ ] If adding new dependencies, verified they have an [OpenSSF
Scorecard](https://securityscorecards.dev/#the-checks) score of 5.0 or
higher (or obtained explicit TSC approval for lower scores).

## Release Notes
```
== NO RELEASE NOTE ==
```
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