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 70f36c0

Browse filesBrowse files
committed
DOC: Fix overly long header underlining.
1 parent 052583d commit 70f36c0
Copy full SHA for 70f36c0

File tree

Expand file treeCollapse file tree

8 files changed

+29
-29
lines changed
Filter options
Expand file treeCollapse file tree

8 files changed

+29
-29
lines changed

‎lib/matplotlib/axes/_axes.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_axes.py
+8-8Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
775775
776776
777777
Examples
778-
---------
778+
--------
779779
* draw a thick red vline at *x* = 0 that spans the yrange::
780780
781781
>>> axvline(linewidth=4, color='r')
@@ -1044,7 +1044,7 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
10441044
hlines : horizontal lines
10451045
10461046
Examples
1047-
---------
1047+
--------
10481048
.. plot:: mpl_examples/pylab_examples/vline_hline_demo.py
10491049
10501050
"""
@@ -1710,7 +1710,7 @@ def acorr(self, x, **kwargs):
17101710
- `b` is the x-axis.
17111711
17121712
Other parameters
1713-
-----------------
1713+
----------------
17141714
linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None
17151715
Only used if usevlines is False.
17161716
@@ -1775,7 +1775,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
17751775
- `b` is the x-axis (none, if plot is used).
17761776
17771777
Other parameters
1778-
-----------------
1778+
----------------
17791779
linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None
17801780
Only used if usevlines is False.
17811781
@@ -2228,7 +2228,7 @@ def barh(self, bottom, width, height=0.8, left=None, **kwargs):
22282228
the x coordinates of the left sides of the bars
22292229
22302230
Returns
2231-
--------
2231+
-------
22322232
`matplotlib.patches.Rectangle` instances.
22332233
22342234
Other parameters
@@ -4844,7 +4844,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
48444844
Display an image on the axes.
48454845
48464846
Parameters
4847-
-----------
4847+
----------
48484848
X : array_like, shape (n, m) or (n, m, 3) or (n, m, 4)
48494849
Display the image in `X` to current axes. `X` may be a float
48504850
array, a uint8 array or a PIL image. If `X` is an array, it
@@ -4924,7 +4924,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
49244924
when interpolation is one of: 'sinc', 'lanczos' or 'blackman'
49254925
49264926
Returns
4927-
--------
4927+
-------
49284928
image : `~matplotlib.image.AxesImage`
49294929
49304930
Other parameters
@@ -6335,7 +6335,7 @@ def hist2d(self, x, y, bins=10, range=None, normed=False, weights=None,
63356335
The return value is ``(counts, xedges, yedges, Image)``.
63366336
63376337
Other parameters
6338-
-----------------
6338+
----------------
63396339
kwargs : :meth:`pcolorfast` properties.
63406340
63416341
See also

‎lib/matplotlib/backend_managers.py

Copy file name to clipboardExpand all lines: lib/matplotlib/backend_managers.py
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def toolmanager_connect(self, s, func):
7979
Connect event with string *s* to *func*.
8080
8181
Parameters
82-
-----------
82+
----------
8383
s : String
8484
Name of the event
8585
@@ -138,7 +138,7 @@ def get_tool_keymap(self, name):
138138
Name of the Tool
139139
140140
Returns
141-
----------
141+
-------
142142
list : list of keys associated with the Tool
143143
"""
144144

@@ -379,7 +379,7 @@ def get_tool(self, name, warn=True):
379379
Return the tool object, also accepts the actual tool for convenience
380380
381381
Parameters
382-
-----------
382+
----------
383383
name : str, ToolBase
384384
Name of the tool, or the tool itself
385385
warn : bool, optional

‎lib/matplotlib/cbook.py

Copy file name to clipboardExpand all lines: lib/matplotlib/cbook.py
+5-5Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def warn_deprecated(
8686
Used to display deprecation warning in a standard way.
8787
8888
Parameters
89-
------------
89+
----------
9090
since : str
9191
The release at which this API became deprecated.
9292
@@ -143,7 +143,7 @@ def deprecated(since, message='', name='', alternative='', pending=False,
143143
Decorator to mark a function as deprecated.
144144
145145
Parameters
146-
------------
146+
----------
147147
since : str
148148
The release at which this API became deprecated. This is
149149
required.
@@ -599,7 +599,7 @@ def local_over_kwdict(local_var, kwargs, *keys):
599599
kwargs dict in place.
600600
601601
Parameters
602-
------------
602+
----------
603603
local_var: any object
604604
The local variable (highest priority)
605605
@@ -611,12 +611,12 @@ def local_over_kwdict(local_var, kwargs, *keys):
611611
priority
612612
613613
Returns
614-
---------
614+
-------
615615
out: any object
616616
Either local_var or one of kwargs[key] for key in keys
617617
618618
Raises
619-
--------
619+
------
620620
IgnoredKeywordWarning
621621
For each key in keys that is removed from kwargs but not used as
622622
the output value

‎lib/matplotlib/lines.py

Copy file name to clipboardExpand all lines: lib/matplotlib/lines.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1066,7 +1066,7 @@ def set_marker(self, marker):
10661066
ACCEPTS: :mod:`A valid marker style <matplotlib.markers>`
10671067
10681068
Parameters
1069-
-----------
1069+
----------
10701070
10711071
marker: marker style
10721072
See `~matplotlib.markers` for full description of possible

‎lib/matplotlib/mlab.py

Copy file name to clipboardExpand all lines: lib/matplotlib/mlab.py
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
commands with the same names.
55
66
MATLAB compatible functions
7-
-------------------------------
7+
---------------------------
88
99
:func:`cohere`
1010
Coherence (normalized cross spectral density)
@@ -39,7 +39,7 @@
3939
Spectrogram (spectrum over segments of time)
4040
4141
Miscellaneous functions
42-
-------------------------
42+
-----------------------
4343
4444
Functions that don't exist in MATLAB, but are useful anyway:
4545
@@ -99,7 +99,7 @@
9999
100100
101101
record array helper functions
102-
-------------------------------
102+
-----------------------------
103103
104104
A collection of helper methods for numpyrecord arrays
105105

‎lib/matplotlib/pyplot.py

Copy file name to clipboardExpand all lines: lib/matplotlib/pyplot.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -913,7 +913,7 @@ def gca(**kwargs):
913913
current figure matching the given keyword args, or create one.
914914
915915
Examples
916-
---------
916+
--------
917917
To get the current polar axes on the current figure::
918918
919919
plt.gca(projection='polar')

‎lib/matplotlib/tri/triinterpolate.py

Copy file name to clipboardExpand all lines: lib/matplotlib/tri/triinterpolate.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1334,14 +1334,14 @@ def _cg(A, b, x0=None, tol=1.e-10, maxiter=1000):
13341334
Right hand side of the linear system.
13351335
13361336
Returns
1337-
----------
1337+
-------
13381338
x: array.
13391339
The converged solution.
13401340
err: float
13411341
The absolute error np.linalg.norm(A.dot(x) - b)
13421342
13431343
Other parameters
1344-
----------
1344+
----------------
13451345
x0: array.
13461346
Starting guess for the solution.
13471347
tol: float.

‎lib/mpl_toolkits/axes_grid1/anchored_artists.py

Copy file name to clipboardExpand all lines: lib/mpl_toolkits/axes_grid1/anchored_artists.py
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ def __init__(self, transform, size, label, loc,
7676
Draw a horizontal bar with the size in data coordinate of the given axes.
7777
A label will be drawn underneath (center-aligned).
7878
79-
Parameters:
80-
-----------
79+
Parameters
80+
----------
8181
transform : matplotlib transformation object
8282
size : int or float
8383
horizontal length of the size bar, given in data coordinates
@@ -100,12 +100,12 @@ def __init__(self, transform, size, label, loc,
100100
fontproperties: a matplotlib.font_manager.FontProperties instance, optional
101101
sets the font properties for the label text
102102
103-
Returns:
104-
--------
103+
Returns
104+
-------
105105
AnchoredSizeBar object
106106
107-
Example:
108-
--------
107+
Example
108+
-------
109109
>>> import matplotlib.pyplot as plt
110110
>>> import numpy as np
111111
>>> from mpl_toolkits.axes_grid1.anchored_artists import AnchoredSizeBar

0 commit comments

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