Skip to content

Commit 2a63ebf

Browse files
DOC: fix SA01,ES01 for pandas.errors.PossibleDataLossError
1 parent ee0902a commit 2a63ebf

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
117117
-i "pandas.errors.NumbaUtilError SA01" \
118118
-i "pandas.errors.OutOfBoundsTimedelta SA01" \
119119
-i "pandas.errors.PerformanceWarning SA01" \
120-
-i "pandas.errors.PossibleDataLossError SA01" \
121120
-i "pandas.errors.UndefinedVariableError PR01,SA01" \
122121
-i "pandas.errors.UnsortedIndexError SA01" \
123122
-i "pandas.errors.ValueLabelTypeMismatch SA01" \

pandas/errors/__init__.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -633,6 +633,15 @@ class PossibleDataLossError(Exception):
633633
"""
634634
Exception raised when trying to open a HDFStore file when already opened.
635635
636+
This error is triggered when there is a potential risk of data loss due to
637+
conflicting operations on an HDFStore file. It serves to prevent unintended
638+
overwrites or data corruption by enforcing exclusive access to the file.
639+
640+
See Also
641+
--------
642+
HDFStore : Dict-like IO interface for storing pandas objects in PyTables.
643+
HDFStore.open : Open an HDFStore file in the specified mode.
644+
636645
Examples
637646
--------
638647
>>> store = pd.HDFStore("my-store", "a") # doctest: +SKIP

0 commit comments

Comments
 (0)