Skip to content

Commit be81793

Browse files
committed
Doc: typo fix for matplotlib#22699
Got merged with small typo in docstring (surprised it wasn't caught by the pre-commit :/) so fixed that. Also added a comma b/c phrase seemed parenthetical.
1 parent 075c5bc commit be81793

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lib/matplotlib/_docstring.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ def kwarg_doc(text):
88
Decorator for defining the kwdoc documentation of artist properties.
99
1010
This decorator can be applied to artist property setter methods.
11-
The given text is stored in a privat attribute ``_kwarg_doc`` on
11+
The given text is stored in a private attribute ``_kwarg_doc`` on
1212
the method. It is used to overwrite auto-generated documentation
1313
in the *kwdoc list* for artists. The kwdoc list is used to document
1414
``**kwargs`` when they are properties of an artist. See e.g. the
1515
``**kwargs`` section in `.Axes.text`.
1616
17-
The text should contain the supported types as well as the default value
18-
if applicable, e.g.:
17+
The text should contain the supported types, as well as the default
18+
value if applicable, e.g.:
1919
2020
@_docstring.kwarg_doc("bool, default: :rc:`text.usetex`")
2121
def set_usetex(self, usetex):

0 commit comments

Comments
 (0)