DOC: Ensure pandas warnings & exceptions are always documented in API docs #43029
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
|
lgtm. @MarcoGorelli if any comments. |
MarcoGorelli
suggested changes
Aug 17, 2021
scripts/pandas_errors_documented.py
Outdated
| import sys | ||
| from typing import Sequence | ||
|
|
||
| API_PATH = "doc/source/reference/general_utility_functions.rst" |
There was a problem hiding this comment.
would this work if someone runs this hook on Windows?
MarcoGorelli
approved these changes
Aug 18, 2021
|
Yeah I suspect these types of checks could be done elsewhere. It might be trickier for other API sections depending on the import structure. |
feefladder
pushed a commit
to feefladder/pandas
that referenced
this pull request
Sep 7, 2021
… docs (pandas-dev#43029) * DOC: Ensure all pandas.errors are documents in general_utility_functions.rst * Use ast to check for the errors * Use pathlib to ensure Windows support
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.
Also adds a pre-commit check that errors in
doc/source/reference/general_utility_functions.rstare synced withpandas/errors/__init__.py