Repository navigation
[DOC-5942] Fix build-directory-dependent API source links - #4413
Draft
sfc-gh-qding wants to merge 2 commits into
Draft
sfc-gh-qding wants to merge 2 commits into
sfc-gh-qding wants to merge 2 commits into
Conversation
Resolve source paths relative to the repository and test decorated methods and properties without importing Sphinx configuration. 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
added
the
NO-CHANGELOG-UPDATES
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 #4413 +/- ##
==========================================
- Coverage 95.46% 95.34% -0.13%
==========================================
Files 176 176
Lines 45271 45295 +24
Branches 7759 7766 +7
==========================================
- Hits 43220 43188 -32
- Misses 1270 1319 +49
- Partials 781 788 +7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
API reference Source links can include incorrect paths because the resolver uses the build working directory. Resolve paths relative to the repository root, unwrap properties and decorated methods consistently, and omit links for objects outside the repository.
Test plan
Generated with Snowflake CoCo
DOC-5942: repair and prevention
Companion historical repair: https://github.com/snowflake-eng/snowflake-prod-docs/pull/26445 fixes 8,340 already-generated Source links across versions 1.25.0–1.30.0. All 299 unique tagged source-file targets were verified. This SDK PR prevents recurrence; the companion repairs published artifacts. Keep DOC-5942 open until that repair is published and live links are verified.
CI follow-up
Corrected test import ordering and the required repository license header. Pinned isort 5.12.0, Black 22.3.0, flake8 5.0.4 and nine regression tests pass. Applied the supported NO-CHANGELOG-UPDATES documentation exemption. Earlier coverage failed with No data to combine after tests were skipped; the Jenkins Snowpark Connect failure remains unverified. New CI is pending.