Skip to content

[docs] document Prestissimo reduce_agg behavior#21981

Merged
tdcmeehan merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-prestissimo-reduce-agg
Feb 22, 2024
Merged

[docs] document Prestissimo reduce_agg behavior#21981
tdcmeehan merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-prestissimo-reduce-agg

Conversation

@steveburnett
Copy link
Contributor

@steveburnett steveburnett commented Feb 21, 2024

Description

Adds documentation of the behavior of reduce_agg in Prestissimo as requested in Issue 21179.

To contain this and future related content, this PR adds a new page "Prestissimo Limitations" to the Prestissimo Developer Guide documentation - parallel to the existing page "Prestissimo Features".
(The Prestissimo Developer Guide documentation was restructured in PR 21953.)

My thanks to @tdcmeehan for providing the draft explanation of the behavior of reduce_agg in Prestissimo.

Motivation and Context

Fixes Issue 21179.

Impact

Documentation.

Test Plan

Screenshots of the local build of documentation:

  1. Prestissimo Developer Guide index page, showing new Limitations page link in left navbar and also in the page (center, bottom).
Screenshot 2024-02-21 at 10 56 44 AM
  1. Limitations page, showing the reduce_agg description in context.
Screenshot 2024-02-21 at 10 58 11 AM

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Can this use a relative URL?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch! Yes it can.

Edited RST file locally to use relative URL (../functions/aggregate.html#reduce_agg), made a new local build, and tested link with relative URL.

  • The link displays correctly on the page.
  • Selecting the link takes me to the correct destination.

Updated PR and squashed commits.

@steveburnett steveburnett force-pushed the steveburnett-prestissimo-reduce-agg branch from 79cceec to b6c30ac Compare February 21, 2024 19:59
@tdcmeehan tdcmeehan merged commit dd25670 into prestodb:master Feb 22, 2024
@steveburnett steveburnett deleted the steveburnett-prestissimo-reduce-agg branch February 22, 2024 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

3 participants