docs: ensure that PlotAccessor is included in the API reference#17513
Open
tswast wants to merge 2 commits into
Open
docs: ensure that PlotAccessor is included in the API reference#17513tswast wants to merge 2 commits into
tswast wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request exposes PlotAccessor in the public typing API and updates its references in the documentation templates and docstrings. It also updates the docstring decorator in _tools/docs.py to copy docstrings to property getters. The review feedback recommends making the decorator more robust by separating the docstring assignment of the descriptor from its underlying callable, preventing an AttributeError on the descriptor from skipping the getter's docstring assignment, and extending support to other descriptors like classmethod and cached_property.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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
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.
Currently, this page is blank.
After this change:
🦕