Skip to content

fix(docs): Added documentation for the comparator version of array_top_n#27010

Merged
allenshen13 merged 1 commit intomasterfrom
add-array-topn-docs
Jan 22, 2026
Merged

fix(docs): Added documentation for the comparator version of array_top_n#27010
allenshen13 merged 1 commit intomasterfrom
add-array-topn-docs

Conversation

@allenshen13
Copy link
Copy Markdown
Member

Description

Added documentation for the comparator version of array_top_n.

Motivation and Context

Functionality exists without documentation.

Release Notes

== NO RELEASE NOTE ==

@allenshen13 allenshen13 requested review from a team, elharo and steveburnett as code owners January 22, 2026 00:02
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Jan 22, 2026
@prestodb-ci prestodb-ci requested review from a team, libianoss and xin-zhang2 and removed request for a team January 22, 2026 00:02
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Jan 22, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documents the comparator-based overload of array_top_n in the array functions reference, filling in previously missing documentation.

File-Level Changes

Change Details Files
Document the comparator overload of array_top_n in the array functions reference.
  • Extend the array_top_n function docs to describe the variant that accepts a comparator argument.
  • Add syntax and parameter description for the comparator version alongside or near the existing array_top_n documentation.
  • Ensure examples and wording clarify the behavior and ordering semantics when a custom comparator is provided.
presto-docs/src/main/sphinx/functions/array.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
Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

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


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.

LGTM! (docs)

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

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to ✅ Done in Presto Documentation Jan 22, 2026
@allenshen13 allenshen13 merged commit 4e91f15 into master Jan 22, 2026
88 checks passed
@allenshen13 allenshen13 deleted the add-array-topn-docs branch January 22, 2026 21:04
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.

3 participants