Skip to content

DOC: Partial fix SA04 errors in docstrings #28792 (feedback needed) #32823

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

Merged
merged 7 commits into from
Mar 31, 2020
Merged

DOC: Partial fix SA04 errors in docstrings #28792 (feedback needed) #32823

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
778c2c1
DOC: Partial fix SA04 errors in docstrings #28792
dilex42 Mar 24, 2020
ed6b3b6
Merge remote-tracking branch 'upstream/master' into sa-errors
dilex42 Mar 24, 2020
d46b39c
DOC: Partial fix SA04 errors in docstrings #28792
dilex42 Mar 24, 2020
cb62a81
formatting
dilex42 Mar 24, 2020
a9f1bdd
Apply suggestions from code review
dilex42 Mar 25, 2020
eef2558
Apply suggestions from code review
Mar 29, 2020
25a7329
Merge remote-tracking branch 'upstream/master' into sa-errors
Mar 29, 2020
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
12 changes: 6 additions & 6 deletions pandas/core/arrays/categorical.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ def categories(self):
add_categories : Add new categories.
remove_categories : Remove the specified categories.
remove_unused_categories : Remove categories which are not used.
set_categories : Set the categories to the specified categories.
set_categories : Set the categories to the specified ones.
"""
return self.dtype.categories

Expand Down Expand Up @@ -905,7 +905,7 @@ def rename_categories(self, new_categories, inplace=False):
add_categories : Add new categories.
remove_categories : Remove the specified categories.
remove_unused_categories : Remove categories which are not used.
set_categories : Set the categories to the specified categories.
set_categories : Set the categories to the specified ones.

Examples
--------
Expand Down Expand Up @@ -973,7 +973,7 @@ def reorder_categories(self, new_categories, ordered=None, inplace=False):
add_categories : Add new categories.
remove_categories : Remove the specified categories.
remove_unused_categories : Remove categories which are not used.
set_categories : Set the categories to the specified categories.
set_categories : Set the categories to the specified ones.
"""
inplace = validate_bool_kwarg(inplace, "inplace")
if set(self.dtype.categories) != set(new_categories):
Expand Down Expand Up @@ -1013,7 +1013,7 @@ def add_categories(self, new_categories, inplace=False):
reorder_categories : Reorder categories.
remove_categories : Remove the specified categories.
remove_unused_categories : Remove categories which are not used.
set_categories : Set the categories to the specified categories.
set_categories : Set the categories to the specified ones.
"""
inplace = validate_bool_kwarg(inplace, "inplace")
if not is_list_like(new_categories):
Expand Down Expand Up @@ -1062,7 +1062,7 @@ def remove_categories(self, removals, inplace=False):
reorder_categories : Reorder categories.
add_categories : Add new categories.
remove_unused_categories : Remove categories which are not used.
set_categories : Set the categories to the specified categories.
set_categories : Set the categories to the specified ones.
"""
inplace = validate_bool_kwarg(inplace, "inplace")
if not is_list_like(removals):
Expand Down Expand Up @@ -1104,7 +1104,7 @@ def remove_unused_categories(self, inplace=False):
reorder_categories : Reorder categories.
add_categories : Add new categories.
remove_categories : Remove the specified categories.
set_categories : Set the categories to the specified categories.
set_categories : Set the categories to the specified ones.
"""
inplace = validate_bool_kwarg(inplace, "inplace")
cat = self if inplace else self.copy()
Expand Down
4 changes: 2 additions & 2 deletions pandas/plotting/_misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def table(ax, data, rowLabels=None, colLabels=None, **kwargs):

def register():
"""
Register pandas Formatters and Converters with matplotlib.
Register pandas formatters and converters with matplotlib.

This function modifies the global ``matplotlib.units.registry``
dictionary. Pandas adds custom converters for
Expand Down Expand Up @@ -62,7 +62,7 @@ def deregister():

See Also
--------
register_matplotlib_converters : Register pandas Formatters and Converters
register_matplotlib_converters : Register pandas formatters and fonverters
with matplotlib.
"""
plot_backend = _get_plot_backend("matplotlib")
Expand Down