Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SNOW-1826257]: Refactor docs to provide one place for supported aggregation functions #2680

Merged
merged 8 commits into from
Dec 16, 2024

Conversation

sfc-gh-rdurrani
Copy link
Contributor

  1. Which Jira issue is this PR addressing? Make sure that there is an accompanying issue to your PR.

    Fixes SNOW-1826257

  2. Fill out the following pre-review checklist:

    • I am adding a new automated test(s) to verify correctness of my new code
      • If this test skips Local Testing mode, I'm requesting review from @snowflakedb/local-testing
    • I am adding new logging messages
    • I am adding a new telemetry message
    • I am adding new credentials
    • I am adding a new dependency
    • If this is a new feature/behavior, I'm adding the Local Testing parity changes.
    • I acknowledge that I have ensured my changes to be thread-safe. Follow the link for more information: Thread-safe Developer Guidelines
  3. Please describe how your code solves the related issue.

There are four functions that provide aggregation - DataFrame.agg, Series.agg, DataFrameGroupBy.agg, and SeriesGroupBy.agg. They share similar code paths, so whenever an aggregation function is added, it generally supports more than one of the APIs. We document each API in a different page though, so code authors need to update 3-4 different docs - which can lead to inconsistent docs (in the case that someone forgets to update one or all of the docs). This refactor moves all documentation of supported aggregation functions to one page, which should help keep the docs consistent and correct.

docs/source/modin/supported/agg_supp.rst Show resolved Hide resolved
docs/source/modin/supported/agg_supp.rst Outdated Show resolved Hide resolved
docs/source/modin/supported/agg_supp.rst Outdated Show resolved Hide resolved
@sfc-gh-rdurrani sfc-gh-rdurrani added NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md NO-PANDAS-CHANGEDOC-UPDATES This PR does not update Snowpark pandas docs labels Dec 2, 2024
@sfc-gh-rdurrani sfc-gh-rdurrani enabled auto-merge (squash) December 13, 2024 02:56
@sfc-gh-rdurrani sfc-gh-rdurrani merged commit 665bef1 into main Dec 16, 2024
38 checks passed
@sfc-gh-rdurrani sfc-gh-rdurrani deleted the rdurrani-SNOW-1826257 branch December 16, 2024 23:07
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md NO-PANDAS-CHANGEDOC-UPDATES This PR does not update Snowpark pandas docs snowpark-pandas
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants