Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: fix SA01, ES01 for pandas.errors.ClosedFileError #59924

Merged
merged 1 commit into from
Sep 30, 2024
Merged

DOC: fix SA01, ES01 for pandas.errors.ClosedFileError #59924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.errors.CSSWarning SA01" \
-i "pandas.errors.CategoricalConversionWarning SA01" \
-i "pandas.errors.ChainedAssignmentError SA01" \
-i "pandas.errors.ClosedFileError SA01" \
-i "pandas.errors.DataError SA01" \
-i "pandas.errors.DuplicateLabelError SA01" \
-i "pandas.errors.IntCastingNaNError SA01" \
Expand Down
10 changes: 10 additions & 0 deletions pandas/errors/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,6 +615,16 @@ class ClosedFileError(Exception):
"""
Exception is raised when trying to perform an operation on a closed HDFStore file.

``ClosedFileError`` is specific to operations on ``HDFStore`` objects. Once an
HDFStore is closed, its resources are no longer available, and any further attempt
to access data or perform file operations will raise this exception.

See Also
--------
HDFStore.close : Closes the PyTables file handle.
HDFStore.open : Opens the file in the specified mode.
HDFStore.is_open : Returns a boolean indicating whether the file is open.

Examples
--------
>>> store = pd.HDFStore("my-store", "a") # doctest: +SKIP
Expand Down
Loading