Skip to content

Commit b8e4a3e

Browse files
authored
DOC: Removed InvalidComparison and LossySetItemError from docs (#54216)
* Removed InvalidComparison and LossySetItemError from docs * Revert "Removed InvalidComparison and LossySetItemError from docs" This reverts commit b9cf502. * internal errors * Examples to Notes on docstring * removed extra lines * merge w main and code_check change
1 parent dfc4c39 commit b8e4a3e

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
6464
MSG='Partially validate docstrings (EX01)' ; echo $MSG
6565
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \
6666
pandas.errors.IncompatibilityWarning \
67-
pandas.errors.InvalidComparison \
68-
pandas.errors.LossySetitemError \
6967
pandas.errors.NoBufferPresent \
7068
pandas.errors.OptionError \
7169
pandas.errors.PerformanceWarning \

pandas/errors/__init__.py

+8
Original file line numberDiff line numberDiff line change
@@ -686,6 +686,10 @@ class CategoricalConversionWarning(Warning):
686686
class LossySetitemError(Exception):
687687
"""
688688
Raised when trying to do a __setitem__ on an np.ndarray that is not lossless.
689+
690+
Notes
691+
-----
692+
This is an internal error.
689693
"""
690694

691695

@@ -698,6 +702,10 @@ class NoBufferPresent(Exception):
698702
class InvalidComparison(Exception):
699703
"""
700704
Exception is raised by _validate_comparison_value to indicate an invalid comparison.
705+
706+
Notes
707+
-----
708+
This is an internal error.
701709
"""
702710

703711

scripts/validate_docstrings.py

+2
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@
4949
"Styler.template_latex",
5050
"Styler.template_string",
5151
"Styler.loader",
52+
"errors.InvalidComparison",
53+
"errors.LossySetitemError",
5254
}
5355
PRIVATE_CLASSES = ["NDFrame", "IndexOpsMixin"]
5456
ERROR_MSGS = {

0 commit comments

Comments
 (0)