DOC: Add guide links to relevant API docs #62650
Open
Conversation
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
- Add links from API reference pages back to user guides - Links Series, DataFrame, Index, GroupBy, IO, Window, Plotting, Style, General Functions, Missing Values, and Resampling APIs to their corresponding user guide sections - Addresses issue pandas-dev#62357: Ensure guides are linked from relevant API docs Files modified: - doc/source/reference/series.rst → Essential basic functionality - doc/source/reference/frame.rst → Essential basic functionality - doc/source/reference/indexing.rst → Essential basic functionality - doc/source/reference/groupby.rst → Group by: split-apply-combine - doc/source/reference/io.rst → IO Tools - doc/source/reference/window.rst → Windowing operations - doc/source/reference/plotting.rst → Visualization - doc/source/reference/general_functions.rst → Reshaping and pivot tables - doc/source/reference/missing_value.rst → Working with missing data - doc/source/reference/resampling.rst → Time series / date functionality - doc/source/reference/style.rst → Table Visualization
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
This PR addresses issue #62357 by adding strategic links from API reference documentation back to relevant user guides, making the guides more discoverable for users.
Changes Made
Added cross-references from the following API documentation files to their corresponding user guide sections:
doc/source/reference/series.rst → Essential basic functionality
doc/source/reference/frame.rst → Essential basic functionality
doc/source/reference/indexing.rst → Essential basic functionality
doc/source/reference/groupby.rst → Group by: split-apply-combine
doc/source/reference/io.rst → IO Tools
doc/source/reference/window.rst → Windowing operations
doc/source/reference/plotting.rst → Visualization
doc/source/reference/general_functions.rst → Reshaping and pivot tables
doc/source/reference/missing_value.rst → Working with missing data
doc/source/reference/resampling.rst → Time series / date functionality
doc/source/reference/style.rst → Table Visualization
Issue Reference
Closes #62357