Skip to content

Commit 3c2c5f4

Browse files
DOC: fix SA01 for pandas.errors.InvalidVersion (#59984)
1 parent 4c96205 commit 3c2c5f4

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
160160
-i "pandas.errors.DuplicateLabelError SA01" \
161161
-i "pandas.errors.IntCastingNaNError SA01" \
162162
-i "pandas.errors.InvalidIndexError SA01" \
163-
-i "pandas.errors.InvalidVersion SA01" \
164163
-i "pandas.errors.NullFrequencyError SA01" \
165164
-i "pandas.errors.NumExprClobberingError SA01" \
166165
-i "pandas.errors.NumbaUtilError SA01" \

pandas/util/version/__init__.py

+8
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,14 @@ class InvalidVersion(ValueError):
114114
"""
115115
An invalid version was found, users should refer to PEP 440.
116116
117+
The ``InvalidVersion`` exception is raised when a version string is
118+
improperly formatted. Pandas uses this exception to ensure that all
119+
version strings are PEP 440 compliant.
120+
121+
See Also
122+
--------
123+
util.version.Version : Class for handling and parsing version strings.
124+
117125
Examples
118126
--------
119127
>>> pd.util.version.Version("1.")

0 commit comments

Comments
 (0)