Skip to content

DOC: Removed InvalidComparison and LossySetItemError from docs #54216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 25, 2023
Merged

DOC: Removed InvalidComparison and LossySetItemError from docs #54216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b9cf502
Removed InvalidComparison and LossySetItemError from docs
DeaMariaLeon Jul 21, 2023
b6f2337
Revert "Removed InvalidComparison and LossySetItemError from docs"
DeaMariaLeon Jul 24, 2023
60295b8
internal errors
DeaMariaLeon Jul 24, 2023
4968ad3
Merge remote-tracking branch 'upstream/main' into Jul21
DeaMariaLeon Jul 24, 2023
69bcc97
Examples to Notes on docstring
DeaMariaLeon Jul 24, 2023
09cc1fb
removed extra lines
DeaMariaLeon Jul 24, 2023
d5567e0
Merge remote-tracking branch 'upstream/main' into Jul21
DeaMariaLeon Jul 24, 2023
f12523f
merge w main and code_check change
DeaMariaLeon Jul 24, 2023
b0231cc
Merge remote-tracking branch 'upstream/main' into Jul21
DeaMariaLeon Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
MSG='Partially validate docstrings (EX01)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \
pandas.errors.IncompatibilityWarning \
pandas.errors.InvalidComparison \
pandas.errors.LossySetitemError \
pandas.errors.NoBufferPresent \
pandas.errors.OptionError \
pandas.errors.PerformanceWarning \
Expand Down
8 changes: 8 additions & 0 deletions pandas/errors/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,6 +686,10 @@ class CategoricalConversionWarning(Warning):
class LossySetitemError(Exception):
"""
Raised when trying to do a __setitem__ on an np.ndarray that is not lossless.

Notes
-----
This is an internal error.
"""


Expand All @@ -698,6 +702,10 @@ class NoBufferPresent(Exception):
class InvalidComparison(Exception):
"""
Exception is raised by _validate_comparison_value to indicate an invalid comparison.

Notes
-----
This is an internal error.
"""


Expand Down
2 changes: 2 additions & 0 deletions scripts/validate_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@
"Styler.template_latex",
"Styler.template_string",
"Styler.loader",
"errors.InvalidComparison",
"errors.LossySetitemError",
}
PRIVATE_CLASSES = ["NDFrame", "IndexOpsMixin"]
ERROR_MSGS = {
Expand Down