Skip to content

Correct cross-references in documentation #22698

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 1 commit into from
Mar 30, 2022
+12 −10
Merged

Correct cross-references in documentation #22698

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
5 changes: 3 additions & 2 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7869,8 +7869,9 @@ def violinplot(self, dataset, positions=None, vert=True, widths=0.5,
The method used to calculate the estimator bandwidth. This can be
'scott', 'silverman', a scalar constant or a callable. If a
scalar, this will be used directly as `kde.factor`. If a
callable, it should take a `GaussianKDE` instance as its only
parameter and return a scalar. If None (default), 'scott' is used.
callable, it should take a `matplotlib.mlab.GaussianKDE` instance as
its only parameter and return a scalar. If None (default), 'scott'
is used.

data : indexable object, optional
DATA_PARAMETER_PLACEHOLDER
Expand Down
9 changes: 5 additions & 4 deletions lib/matplotlib/backend_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1006,8 +1006,8 @@ def add_tools_to_manager(toolmanager, tools=default_tools):
toolmanager : `.backend_managers.ToolManager`
Manager to which the tools are added.
tools : {str: class_like}, optional
The tools to add in a {name: tool} dict, see `add_tool` for more
info.
The tools to add in a {name: tool} dict, see
`.backend_managers.ToolManager.add_tool` for more info.
"""

for name, tool in tools.items():
Expand All @@ -1021,11 +1021,12 @@ def add_tools_to_container(container, tools=default_toolbar_tools):
Parameters
----------
container : Container
`backend_bases.ToolContainerBase` object that will get the tools added.
`.backend_bases.ToolContainerBase` object that will get the tools
added.
tools : list, optional
List in the form ``[[group1, [tool1, tool2 ...]], [group2, [...]]]``
where the tools ``[tool1, tool2, ...]`` will display in group1.
See `add_tool` for details.
See `.backend_bases.ToolContainerBase.add_tool` for details.
"""

for group, grouptools in tools:
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/path.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ def codes(self):
code is one of `STOP`, `MOVETO`, `LINETO`, `CURVE3`, `CURVE4`
or `CLOSEPOLY`. For codes that correspond to more than one
vertex (`CURVE3` and `CURVE4`), that code will be repeated so
that the length of `self.vertices` and `self.codes` is always
that the length of `vertices` and `codes` is always
the same.
"""
return self._codes
Expand Down
6 changes: 3 additions & 3 deletions lib/matplotlib/transforms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1474,7 +1474,7 @@ def transform(self, values):
Returns
-------
array
The output values as NumPy array of length :attr:`input_dims` or
The output values as NumPy array of length :attr:`output_dims` or
shape (N x :attr:`output_dims`), depending on the input.
"""
# Ensure that values is a 2d array (but remember whether
Expand Down Expand Up @@ -1519,7 +1519,7 @@ def transform_affine(self, values):
Returns
-------
array
The output values as NumPy array of length :attr:`input_dims` or
The output values as NumPy array of length :attr:`output_dims` or
shape (N x :attr:`output_dims`), depending on the input.
"""
return self.get_affine().transform(values)
Expand All @@ -1544,7 +1544,7 @@ def transform_non_affine(self, values):
Returns
-------
array
The output values as NumPy array of length :attr:`input_dims` or
The output values as NumPy array of length :attr:`output_dims` or
shape (N x :attr:`output_dims`), depending on the input.
"""
return values
Expand Down