DOC: fix SA01 for pandas.errors.InvalidVersion (#59984)

pandas-dev · Oct 6, 2024 · 3c2c5f4 · 3c2c5f4
1 parent 4c96205
commit 3c2c5f4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -160,7 +160,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.errors.DuplicateLabelError SA01" \
         -i "pandas.errors.IntCastingNaNError SA01" \
         -i "pandas.errors.InvalidIndexError SA01" \
-        -i "pandas.errors.InvalidVersion SA01" \
         -i "pandas.errors.NullFrequencyError SA01" \
         -i "pandas.errors.NumExprClobberingError SA01" \
         -i "pandas.errors.NumbaUtilError SA01" \

diff --git a/pandas/util/version/__init__.py b/pandas/util/version/__init__.py
@@ -114,6 +114,14 @@ class InvalidVersion(ValueError):
     """
     An invalid version was found, users should refer to PEP 440.
 
+    The ``InvalidVersion`` exception is raised when a version string is
+    improperly formatted. Pandas uses this exception to ensure that all
+    version strings are PEP 440 compliant.
+
+    See Also
+    --------
+    util.version.Version : Class for handling and parsing version strings.
+
     Examples
     --------
     >>> pd.util.version.Version("1.")