Skip to content

[DOC-5375] Consolidate ten Snowpark API documentation improvements - #4407

Merged
sfc-gh-mayliu merged 10 commits into
mainfrom
qding/sdk-docs-batch10
Oct 1, 2026
Merged

sfc-gh-mayliu merged 10 commits into
mainfrom
qding/sdk-docs-batch10

Conversation

@sfc-gh-qding

Copy link
Copy Markdown
Collaborator

Summary

Consolidates ten documentation fixes into one review and CI run, replacing #4397, #4398, #4399, #4400, #4401, #4402, #4403, #4404, #4405, and #4406. All changes are docstrings; runtime behavior is unchanged.

Jira Change Replaces
DOC-5375 Render column_order options separately #4397
DOC-11502 Current-account usage guidance #4398
DOC-11503 Inspect PutResult upload outcomes #4399
DOC-11506 Collect examples and Row access #4400
DOC-11570 Session-stage reference and lifetime #4401
DOC-12200 Table sampling examples and fraction units #4402
DOC-12247 Array element ordering #4403
DOC-13282 Statistical sampling accessor #4404
DOC-13285 collect_list alias and example #4405
DOC-16386 Planned SQL versus cleanup and query history #4406

Validation

  • Re-executed combined docstring examples in isolated Python 3.11 with Snowpark 1.55.0 localtest. Synthetic tables/files only; exact upload/print snippet tested on a mocked stage.
  • Session-stage example uses explicit mocked DDL: no live stage creation or permission validation. Account getter checked with a synthetic connection parameter.
  • Alias example returns [1,2,2]. Prior read-only Snowhouse VALUES query verified ordered ARRAY_AGG DISTINCT versus duplicate retention; local emulator differs for the existing distinct aggregation example.
  • Compared all seven changed files against current main with docstrings removed: executable AST unchanged.
  • Sphinx/Napoleon/docutils parsing introduces no new warnings (collect retains one baseline warning). Column-order options verified as distinct rendered list entries.
  • Black 22.3.0 and git diff checks passed; all ten original commits applied cleanly.
  • Full integration and Sphinx builds run in CI. No live uploads or temporary Snowflake objects created during local validation.

Required acknowledgments

  • I acknowledge that I have ensured my changes to be thread-safe.
  • If adding any arguments to public Snowpark APIs or creating new public Snowpark APIs, I acknowledge that I have ensured my changes include AST support.

Documentation only: no new signatures, shared state, AST encoding, dependencies, credentials, logging, or telemetry. NO-CHANGELOG-UPDATES applies. Jira tickets remain open until this replacement merges.

Generated with Snowflake CoCo

sfc-gh-qding and others added 10 commits September 30, 2026 14:35
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Clarify existing API behavior without changing executable code.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
@codecov-commenter

codecov-commenter commented Sep 30, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.47%. Comparing base (b1173b1) to head (d3b276d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4407   +/-   ##
=======================================
  Coverage   95.47%   95.47%           
=======================================
  Files         176      176           
  Lines       45271    45271           
  Branches     7759     7759           
=======================================
  Hits        43222    43222           
  Misses       1269     1269           
  Partials      780      780           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sfc-gh-mayliu
sfc-gh-mayliu marked this pull request as ready for review October 1, 2026 00:04
@sfc-gh-mayliu
sfc-gh-mayliu requested a review from a team as a code owner October 1, 2026 00:04

@snowflake-security-bot snowflake-security-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Snowflake Security Review

Security grade: A — Passed ✅

This PR was classified as LOW risk by the automated pre-screen.

@sfc-gh-mayliu
sfc-gh-mayliu enabled auto-merge (squash) October 1, 2026 17:49
@sfc-gh-mayliu
sfc-gh-mayliu merged commit e3ddcbb into main Oct 1, 2026
56 of 59 checks passed
@sfc-gh-mayliu
sfc-gh-mayliu deleted the qding/sdk-docs-batch10 branch October 1, 2026 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants