Skip to content

Commit 66ec5f3

Browse files
authored
MAINT: Clean up docs in pandas/errors/__init__.py
1 parent 0cf2b14 commit 66ec5f3

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

pandas/errors/__init__.py

+14-12
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
# flake8: noqa
22

3-
""" expose public exceptions & warnings """
3+
"""
4+
Expose public exceptions & warnings
5+
"""
46

57
from pandas._libs.tslib import OutOfBoundsDatetime
68

79

810
class PerformanceWarning(Warning):
911
"""
10-
Warnings shown when there is a possible performance
11-
impact.
12+
Warning raised when there is a possible
13+
performance impact.
1214
"""
1315

1416
class UnsupportedFunctionCall(ValueError):
1517
"""
16-
If attempting to call a numpy function on a pandas
17-
object. For example using ``np.cumsum(groupby_object)``.
18+
Exception raised when attempting to call a numpy function
19+
on a pandas object, but that function is not supported by
20+
the object e.g. ``np.cumsum(groupby_object)``.
1821
"""
1922

2023
class UnsortedIndexError(KeyError):
2124
"""
22-
Error raised when attempting to get a slice of a MultiIndex
25+
Error raised when attempting to get a slice of a MultiIndex,
2326
and the index has not been lexsorted. Subclass of `KeyError`.
2427
2528
.. versionadded:: 0.20.0
@@ -29,22 +32,22 @@ class UnsortedIndexError(KeyError):
2932

3033
class ParserError(ValueError):
3134
"""
32-
Exception that is thrown by an error is encountered in `pd.read_csv`
35+
Exception that is raised by an error encountered in `pd.read_csv`.
3336
"""
3437

3538

3639
class DtypeWarning(Warning):
3740
"""
38-
Warning that is raised for a dtype incompatiblity. This is
41+
Warning that is raised for a dtype incompatiblity. This
3942
can happen whenever `pd.read_csv` encounters non-
40-
uniform dtypes in a column(s) of a given CSV file
43+
uniform dtypes in a column(s) of a given CSV file.
4144
"""
4245

4346

4447
class EmptyDataError(ValueError):
4548
"""
4649
Exception that is thrown in `pd.read_csv` (by both the C and
47-
Python engines) when empty data or header is encountered
50+
Python engines) when empty data or header is encountered.
4851
"""
4952

5053

@@ -53,13 +56,12 @@ class ParserWarning(Warning):
5356
Warning that is raised in `pd.read_csv` whenever it is necessary
5457
to change parsers (generally from 'c' to 'python') contrary to the
5558
one specified by the user due to lack of support or functionality for
56-
parsing particular attributes of a CSV file with the requsted engine
59+
parsing particular attributes of a CSV file with the requsted engine.
5760
"""
5861

5962

6063
class MergeError(ValueError):
6164
"""
6265
Error raised when problems arise during merging due to problems
6366
with input data. Subclass of `ValueError`.
64-
6567
"""

0 commit comments

Comments
 (0)