Skip to content

Comments

[docs] Add presto_cpp/properties-session.rst#23852

Merged
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-cpp-sessionproperties2
Oct 18, 2024
Merged

[docs] Add presto_cpp/properties-session.rst#23852
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-cpp-sessionproperties2

Conversation

@steveburnett
Copy link
Contributor

@steveburnett steveburnett commented Oct 17, 2024

Description

Add a new page presto_cpp/properties-session.rst, separating out the content in the Session Properties heading in Presto C++ Features to a separate page.

Note: This is a redo of #23789 to resolve the conflict created from the recently merged #23846 and include the session property added in that PR. Local doc builds were used to verify the correct placement of the new native_expression.max_array_size_in_reduce session property in this updated PR.

Motivation and Context

The Presto Properties Reference documentation contains mostly configuration properties, with session properties being mentioned occasionally within the description of the configuration properties, and both categories are incompletely documented.

To elevate the visibility of session properties and hopefully make it easier to eventually address the incompleteness of both categories, session property doc is being moved to its own page that is separate from and parallel to the configuration properties documentation.

Both the Presto and Presto C++ properties documentation need similar refactoring.

This PR addresses only the Presto C++ session properties doc refactoring, to make the PR itself shorter and simpler to review. The work to refactor the larger Presto Properties Reference doc will follow in a separate PR.

Impact

Documentation.

Test Plan

Ran local docs builds to verify that content was where it should be, and that the new and modified pages are correctly formatted.

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 force-pushed the steveburnett-cpp-sessionproperties2 branch from 44a124a to 034f049 Compare October 18, 2024 14:12
@steveburnett
Copy link
Contributor Author

New update to fix native_expression.max_array_size_in_reduce session to native_expression_max_array_size_in_reduce session from #23856. Tested fix in local doc build.

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.

2 participants