Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 3fe3d1a

Browse filesBrowse files
authored
Merge pull request #16858 from QuLogic/docs
Fix various numpydoc style issues
2 parents 72add05 + f9ce5a9 commit 3fe3d1a
Copy full SHA for 3fe3d1a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner
Expand file treeCollapse file tree

42 files changed

+356
-333
lines changed

‎lib/matplotlib/__init__.py

Copy file name to clipboardExpand all lines: lib/matplotlib/__init__.py
+3-1Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1296,7 +1296,8 @@ def _label_from_arg(y, default_name):
12961296

12971297

12981298
def _add_data_doc(docstring, replace_names):
1299-
"""Add documentation for a *data* field to the given docstring.
1299+
"""
1300+
Add documentation for a *data* field to the given docstring.
13001301
13011302
Parameters
13021303
----------
@@ -1309,6 +1310,7 @@ def _add_data_doc(docstring, replace_names):
13091310
13101311
Returns
13111312
-------
1313+
str
13121314
The augmented docstring.
13131315
"""
13141316
if (docstring is None

‎lib/matplotlib/afm.py

Copy file name to clipboardExpand all lines: lib/matplotlib/afm.py
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -286,13 +286,13 @@ def _parse_composites(fh):
286286
287287
Returns
288288
-------
289-
composites : dict
289+
dict
290290
A dict mapping composite character names to a parts list. The parts
291291
list is a list of `.CompositePart` entries describing the parts of
292292
the composite.
293293
294-
Example
295-
-------
294+
Examples
295+
--------
296296
A composite definition line::
297297
298298
CC Aacute 2 ; PCC A 0 0 ; PCC acute 160 170 ;

‎lib/matplotlib/animation.py

Copy file name to clipboardExpand all lines: lib/matplotlib/animation.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ def is_available(self, name):
140140
141141
Returns
142142
-------
143-
available : bool
143+
bool
144144
"""
145145
try:
146146
cls = self._registered[name]
@@ -1281,7 +1281,7 @@ def to_html5_video(self, embed_limit=None):
12811281
12821282
Returns
12831283
-------
1284-
video_tag : str
1284+
str
12851285
An HTML5 video tag with the animation embedded as base64 encoded
12861286
h264 video.
12871287
If the *embed_limit* is exceeded, this returns the string

‎lib/matplotlib/artist.py

Copy file name to clipboardExpand all lines: lib/matplotlib/artist.py
+5-5Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ def get_tightbbox(self, renderer):
274274
275275
Returns
276276
-------
277-
bbox : `.Bbox`
277+
`.Bbox`
278278
The enclosing bounding box (in figure pixel coordinates).
279279
"""
280280
bbox = self.get_window_extent(renderer)
@@ -305,7 +305,7 @@ def func(artist: Artist) -> Any
305305
306306
Returns
307307
-------
308-
oid : int
308+
int
309309
The observer id associated with the callback. This id can be
310310
used for removing the callback with `.remove_callback` later.
311311
@@ -629,7 +629,7 @@ def get_sketch_params(self):
629629
630630
Returns
631631
-------
632-
sketch_params : tuple or None
632+
tuple or None
633633
634634
A 3-tuple with the following elements:
635635
@@ -1109,7 +1109,7 @@ def findobj(self, match=None, include_self=True):
11091109
11101110
Returns
11111111
-------
1112-
artists : list of `.Artist`
1112+
list of `.Artist`
11131113
11141114
"""
11151115
if match is None: # always return True
@@ -1599,7 +1599,7 @@ def kwdoc(artist):
15991599
16001600
Returns
16011601
-------
1602-
string
1602+
str
16031603
The settable properties of *artist*, as plain text if
16041604
:rc:`docstring.hardcopy` is False and as a rst table (intended for
16051605
use in Sphinx) if it is True.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.