Skip to content

Commit 111ff84

Browse files
DOC: fix SA01, ES01 for pandas.errors.ClosedFileError (#59924)
1 parent d66d582 commit 111ff84

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
159159
-i "pandas.errors.CSSWarning SA01" \
160160
-i "pandas.errors.CategoricalConversionWarning SA01" \
161161
-i "pandas.errors.ChainedAssignmentError SA01" \
162-
-i "pandas.errors.ClosedFileError SA01" \
163162
-i "pandas.errors.DataError SA01" \
164163
-i "pandas.errors.DuplicateLabelError SA01" \
165164
-i "pandas.errors.IntCastingNaNError SA01" \

pandas/errors/__init__.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -615,6 +615,16 @@ class ClosedFileError(Exception):
615615
"""
616616
Exception is raised when trying to perform an operation on a closed HDFStore file.
617617
618+
``ClosedFileError`` is specific to operations on ``HDFStore`` objects. Once an
619+
HDFStore is closed, its resources are no longer available, and any further attempt
620+
to access data or perform file operations will raise this exception.
621+
622+
See Also
623+
--------
624+
HDFStore.close : Closes the PyTables file handle.
625+
HDFStore.open : Opens the file in the specified mode.
626+
HDFStore.is_open : Returns a boolean indicating whether the file is open.
627+
618628
Examples
619629
--------
620630
>>> store = pd.HDFStore("my-store", "a") # doctest: +SKIP

0 commit comments

Comments
 (0)