Skip to content

Commit e5da6fd

Browse files
committed
DOC: Rewriting of ParserError doc + minor spacing
Follow-up to pandas-devgh-25414.
1 parent 5557e36 commit e5da6fd

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

pandas/errors/__init__.py

+12-5
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,18 @@
99

1010
class PerformanceWarning(Warning):
1111
"""
12-
Warning raised when there is a possible
13-
performance impact.
12+
Warning raised when there is a possible performance impact.
1413
"""
1514

15+
1616
class UnsupportedFunctionCall(ValueError):
1717
"""
1818
Exception raised when attempting to call a numpy function
1919
on a pandas object, but that function is not supported by
2020
the object e.g. ``np.cumsum(groupby_object)``.
2121
"""
2222

23+
2324
class UnsortedIndexError(KeyError):
2425
"""
2526
Error raised when attempting to get a slice of a MultiIndex,
@@ -31,9 +32,15 @@ class UnsortedIndexError(KeyError):
3132

3233
class ParserError(ValueError):
3334
"""
34-
Exception that is raised by an error encountered in `pd.read_csv`.
35+
Exception that is raised by an error encountered in parsing file contents.
36+
37+
This is a generic error raised for errors encountered when functions like
38+
`read_csv` or `read_html` are parsing contents of a file.
3539
36-
e.g. HTML Parsing will raise this error.
40+
See Also
41+
--------
42+
read_csv : Read CSV (comma-separated) file into a DataFrame.
43+
read_html : Read HTML table into a DataFrame.
3744
"""
3845

3946

@@ -182,4 +189,4 @@ def __str__(self):
182189
else:
183190
name = self.class_instance.__class__.__name__
184191
msg = "This {methodtype} must be defined in the concrete class {name}"
185-
return (msg.format(methodtype=self.methodtype, name=name))
192+
return msg.format(methodtype=self.methodtype, name=name)

0 commit comments

Comments
 (0)