Skip to content

[DOC-5375] Render column_order choices as separate entries - #4397

Closed
sfc-gh-qding wants to merge 1 commit into
mainfrom
qding/DOC-5375-docs
Closed

sfc-gh-qding wants to merge 1 commit into
mainfrom
qding/DOC-5375-docs

Conversation

@sfc-gh-qding

Copy link
Copy Markdown
Collaborator

Summary

DOC-5375: Render column_order choices as separate entries.

Docstring-only clarification of existing API behavior. No executable implementation, signatures, shared state, AST encoding, credentials, dependencies, logging, or telemetry changes.

Validation

Parsed rendered docutils tree and verified a bullet list containing separate index/name entries. Existing append-only semantics retained.

  • Python AST comparison with docstrings removed confirms runtime code unchanged.
  • Sphinx/Napoleon and docutils parsing: no new warnings. Repository-pinned Black 22.3.0 and git diff checks passed.
  • Overlapping session.py, dataframe.py, and array_agg documentation edits merge cleanly pairwise.
  • Full SDK integration and full Sphinx builds deferred to CI. Local tests used isolated Python 3.11 and Snowpark 1.55.0 with localtest; mocks are not live integration 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.

NO-CHANGELOG-UPDATES: documentation-only, no runtime behavior change.

Generated with Snowflake CoCo

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>
@sfc-gh-qding sfc-gh-qding added the NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md label Sep 30, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.47%. Comparing base (5ab7287) to head (fe2780e).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4397      +/-   ##
==========================================
+ Coverage   95.44%   95.47%   +0.02%     
==========================================
  Files         176      176              
  Lines       45271    45271              
  Branches     7759     7759              
==========================================
+ Hits        43209    43222      +13     
+ Misses       1282     1269      -13     
  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-qding

Copy link
Copy Markdown
Collaborator Author

Superseded by consolidated PR #4407: #4407 . This change is preserved in the combined branch and was revalidated with the other nine documentation fixes. Closing only this PR; the associated Jira remains open until #4407 merges.

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.

2 participants