Skip to content

Commit c2aa651

Browse files
DOC: fix SA01 for pandas.errors.InvalidVersion
1 parent 05fa958 commit c2aa651

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
163163
-i "pandas.errors.DuplicateLabelError SA01" \
164164
-i "pandas.errors.IntCastingNaNError SA01" \
165165
-i "pandas.errors.InvalidIndexError SA01" \
166-
-i "pandas.errors.InvalidVersion SA01" \
167166
-i "pandas.errors.NullFrequencyError SA01" \
168167
-i "pandas.errors.NumExprClobberingError SA01" \
169168
-i "pandas.errors.NumbaUtilError SA01" \

pandas/util/version/__init__.py

Lines changed: 8 additions & 0 deletions
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)