8000 DOC: Add missing docstring to API index. · matplotlib/matplotlib@17581c5 · GitHub
[go: up one dir, main page]

Skip to content

Commit 17581c5

Browse files
committed
DOC: Add missing docstring to API index.
1 parent 3fc8fbb commit 17581c5

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

doc/api/docstring_api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
************************
2+
``matplotlib.docstring``
3+
************************
4+
5+
.. automodule:: matplotlib.docstring
6+
:members:
7+
:undoc-members:
8+
:show-inheritance:

doc/api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ Matplotlib consists of the following submodules:
8787
container_api.rst
8888
contour_api.rst
8989
dates_api.rst
90+
docstring_api.rst
9091
dviread.rst
9192
figure_api.rst
9293
font_manager_api.rst

doc/missing-references.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1273,9 +1273,6 @@
12731273
"matplotlib.dates.rrulewrapper": [
12741274
"lib/matplotlib/dates.py:docstring of matplotlib.dates:121"
12751275
],
1276-
"matplotlib.docstring.dedent_interpd": [
1277-
"doc/devel/documenting_mpl.rst:679"
1278-
],
12791276
"matplotlib.sphinxext.mathmpl": [
12801277
"doc/users/prev_whats_new/whats_new_3.0.rst:225"
12811278
],

lib/matplotlib/docstring.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ def from_params(cls, params):
5454
dictionary) and it may change before this class is called, one may
5555
explicitly use a reference to the params rather than using *args or
5656
**kwargs which will copy the values and not reference them.
57+
58+
:meta private:
5759
"""
5860
result = cls()
5961
result.params = params

0 commit comments

Comments
 (0)
0