[DOC-12399] Clarify thirteen Snowpark API reference topics (docstrings only) - #4410
Conversation
Restore missing reference coverage and pandas export documentation, and clarify API behavior with validated examples. Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code) Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Add the required test header and canonical import ordering. Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code) Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4410 +/- ##
=======================================
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. 🚀 New features to boost your workflow:
|
State support limits directly without defensive disclaimers or admonishing readers. Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code) Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
Defer build logic, new tests, broad reference audits and unresolved behavior requests. Attach to_snowflake documentation as a direct docstring so the remaining diff changes documentation only. Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code) Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
|
Narrowed in 9ba2d54 following review feedback. The final diff is now docstrings only in nine Python files: no Sphinx configuration changes, new tests, decorators, reference-index changes, or runtime statements. The failing test_documentation.py addition is removed, and to_snowflake now has a direct function docstring. Compared with PR base e3ddcbb, executable ASTs are identical after removing docstrings. Rebuilt the full Sphinx HTML reference with zero warnings and verified the public to_snowflake parameter documentation. The description now lists 13 closure targets and nine explicitly deferred tickets. CI must rerun on this head; I am not claiming all previous failures are resolved. |
|
Applied NO-PANDAS-CHANGEDOC-UPDATES because the retained pandas change is a direct API docstring; no separate docs/source/modin guide update is needed. The changedoc workflow otherwise requires a file in that directory. No checks or workflow files were modified. |
Summary
Clarify 13 Snowpark API reference topics through Python docstrings only. The final diff contains no changes to executable statements, decorators, documentation constants, Sphinx configuration, reference indexes, or tests.
Following review feedback, the source-link implementation and its new tests have been removed from this PR. Those tests imported Sphinx's full configuration and failed on Python 3.13 because the pinned Sphinx dependency imports the removed
imghdrmodule. Theto_snowflakedocumentation now uses a direct function docstring instead of an added decorator.Tickets targeted for closure after merge
These are closure targets, not claims of already-completed Jira work. Close only after verified merge and ticket-specific review. Changes to current source do not rebuild historical versioned API pages.
Deferred: not resolved by this PR
Validation
e3ddcbbfusing Python ASTs after removing docstrings: identical executable ASTs, with no exceptions for decorators or constants.read_texthelper passed against this checkout.modin.pandas.to_snowflake.__doc__contains the direct parameter documentation without the added decorator.Pre-review checklist
Docstrings only; no new public arguments or execution behavior.
NO-CHANGELOG-UPDATESapplies. Existing test files and Sphinx configuration are unchanged relative to the PR base.Generated with Snowflake CoCo