8000 Correct numpy doc format in cbook api docs · matplotlib/matplotlib@772b093 · GitHub
[go: up one dir, main page]

Skip to content

Commit 772b093

Browse files
committed
Correct numpy doc format in cbook api docs
Example is not an allowed section header in numpydoc but Examples is. Even if we only have one example
1 parent 53c716a commit 772b093

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

lib/matplotlib/cbook.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2382,9 +2382,8 @@ def pts_to_prestep(x, *args):
23822382
will be length ``2N + 1``
23832383
23842384
2385-
Example
2386-
-------
2387-
2385+
Examples
2386+
--------
23882387
>> x_s, y1_s, y2_s = pts_to_prestep(x, y1, y2)
23892388
"""
23902389
# do normalization
@@ -2423,9 +2422,8 @@ def pts_to_poststep(x, *args):
24232422
will be length ``2N + 1``
24242423
24252424
2426-
Example
2427-
-------
2428-
2425+
Examples
2426+
--------
24292427
>> x_s, y1_s, y2_s = pts_to_prestep(x, y1, y2)
24302428
"""
24312429
# do normalization
@@ -2465,9 +2463,8 @@ def pts_to_midstep(x, *args):
24652463
will be length ``2N + 1``
24662464
24672465
2468-
Example
2469-
-------
2470-
2466+
Examples
2467+
--------
24712468
>> x_s, y1_s, y2_s = pts_to_prestep(x, y1, y2)
24722469
"""
24732470
# do normalization

0 commit comments

Comments
 (0)
0