DOC: define typing aliases as Sphinx objects in aliases.rst#63940
Closed
dedlYTiTAN wants to merge 1 commit intopandas-dev:mainfrom
Closed
DOC: define typing aliases as Sphinx objects in aliases.rst#63940dedlYTiTAN wants to merge 1 commit intopandas-dev:mainfrom
dedlYTiTAN wants to merge 1 commit intopandas-dev:mainfrom
Conversation
Member
|
Closing this pull request as it does not follow our contribution guidelines. In particular:
Additionally, 2 warning were already given about AI pull requests #63933 (comment) #63898 (comment) so we will be banning your contributions |
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
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 converts the typing aliases in
doc/source/reference/aliases.rstfrom a staticlist-tableinto proper Sphinx.. type::directives.What I changed
.. module:: pandas.api.typing.aliasesat the top of the file for correct scoping... type::blocks for each alias.I ran a local build to check the RST syntax. I encountered some local environment issues with pyarrow/timezones on Windows during the full User Guide build, but I've verified that the
aliases.rstfile itself parses correctly and the new directives are valid.Fixes #63810