Movatterモバイル変換


[0]ホーム

URL:


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

Sign up
Appearance settings

Commit9fb5333

Browse files
committed
Fix cross-references
1 parentc6c7ec1 commit9fb5333

File tree

15 files changed

+146
-599
lines changed

15 files changed

+146
-599
lines changed

‎doc/missing-references.json

Lines changed: 72 additions & 534 deletions
Large diffs are not rendered by default.

‎examples/misc/ftface_props.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Font properties
44
===============
55
6-
This example lists the attributes of an `.FT2Font` object, which describe
7-
global font properties. For individual character metrics, use the `.Glyph`
8-
object, as returned by `.load_char`.
6+
This example lists the attributes of an ``FT2Font`` object, which describe
7+
global font properties. For individual character metrics, use the ``Glyph``
8+
object, as returned by ``load_char``.
99
"""
1010

1111
importos
@@ -26,9 +26,9 @@
2626
print('PS name: ',font.postscript_name)# the postscript name
2727
print('Num fixed: ',font.num_fixed_sizes)# number of embedded bitmaps
2828

29-
# the following are only available ifface.scalable
29+
# the following are only available iffont.scalable
3030
iffont.scalable:
31-
# theface global bounding box (xmin, ymin, xmax, ymax)
31+
# thefont global bounding box (xmin, ymin, xmax, ymax)
3232
print('Bbox: ',font.bbox)
3333
# number of font units covered by the EM
3434
print('EM: ',font.units_per_EM)

‎lib/matplotlib/artist.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1093,8 +1093,8 @@ def sticky_edges(self):
10931093
``x`` and ``y`` sticky edge lists for autoscaling.
10941094
10951095
When performing autoscaling, if a data limit coincides with a value in
1096-
the corresponding sticky_edges list, then no margin will be added--the
1097-
view limit "sticks" to the edge. A typical use case is histograms,
1096+
the corresponding sticky_edges list, then no margin will be added --
1097+
theview limit "sticks" to the edge. A typical use case is histograms,
10981098
where one usually expects no margin on the bottom edge (0) of the
10991099
histogram.
11001100

‎lib/matplotlib/axes/_axes.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ def inset_axes(self, bounds, *, transform=None, zorder=5, **kwargs):
322322
Lower-left corner of inset Axes, and its width and height.
323323
324324
transform : `.Transform`
325-
Defaults to `ax.transAxes`, i.e. the units of *rect* are in
325+
Defaults to ``ax.transAxes``, i.e. the units of *rect* are in
326326
Axes-relative coordinates.
327327
328328
projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide',\
@@ -409,7 +409,7 @@ def indicate_inset(self, bounds, inset_ax=None, *, transform=None,
409409
410410
transform : `.Transform`
411411
Transform for the rectangle coordinates. Defaults to
412-
`ax.transAxes`, i.e. the units of *rect* are in Axes-relative
412+
``ax.transAxes``, i.e. the units of *rect* are in Axes-relative
413413
coordinates.
414414
415415
facecolor : color, default: 'none'

‎lib/matplotlib/axes/_base.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2222,7 +2222,7 @@ def add_artist(self, a):
22222222

22232223
defadd_child_axes(self,ax):
22242224
"""
2225-
Add an `.AxesBase` to the Axes' children; return the child Axes.
2225+
Add an ``AxesBase`` to the Axes' children; return the child Axes.
22262226
22272227
This is the lowlevel version. See `.axes.Axes.inset_axes`.
22282228
"""
@@ -2481,7 +2481,7 @@ def relim(self, visible_only=False):
24812481

24822482
defupdate_datalim(self,xys,updatex=True,updatey=True):
24832483
"""
2484-
Extend the `~.Axes.dataLim` Bbox to include the given points.
2484+
Extend the ``ax.dataLim`` Bbox to include the given points.
24852485
24862486
If no data is set currently, the Bbox will ignore its limits and set
24872487
the bound to be the bounds of the xydata (*xys*). Otherwise, it will
@@ -2596,7 +2596,7 @@ def set_autoscale_on(self, b):
25962596
@property
25972597
defuse_sticky_edges(self):
25982598
"""
2599-
When autoscaling, whether to obey all `Artist.sticky_edges`.
2599+
When autoscaling, whether to obey all `.Artist.sticky_edges`.
26002600
26012601
Default is ``True``.
26022602
@@ -2705,9 +2705,9 @@ def margins(self, *margins, x=None, y=None, tight=True):
27052705
Notes
27062706
-----
27072707
If a previously used Axes method such as :meth:`pcolor` has set
2708-
:attr:`use_sticky_edges` to `True`, only the limits not set by
2708+
:attr:`~.Axes.use_sticky_edges` to `True`, only the limits not set by
27092709
the "sticky artists" will be modified. To force all of the
2710-
margins to be set, set :attr:`use_sticky_edges` to `False`
2710+
margins to be set, set :attr:`~.Axes.use_sticky_edges` to `False`
27112711
before calling :meth:`margins`.
27122712
"""
27132713

@@ -3570,8 +3570,8 @@ def get_xlim(self):
35703570
See Also
35713571
--------
35723572
.Axes.set_xlim
3573-
set_xbound, get_xbound
3574-
invert_xaxis, xaxis_inverted
3573+
.Axes.set_xbound,.Axes.get_xbound
3574+
.Axes.invert_xaxis,.Axes.xaxis_inverted
35753575
35763576
Notes
35773577
-----
@@ -3637,9 +3637,9 @@ def set_xlim(self, left=None, right=None, emit=True, auto=False,
36373637
36383638
See Also
36393639
--------
3640-
get_xlim
3641-
set_xbound, get_xbound
3642-
invert_xaxis, xaxis_inverted
3640+
.Axes.get_xlim
3641+
.Axes.set_xbound,.Axes.get_xbound
3642+
.Axes.invert_xaxis,.Axes.xaxis_inverted
36433643
36443644
Notes
36453645
-----
@@ -3859,8 +3859,8 @@ def get_ylim(self):
38593859
See Also
38603860
--------
38613861
.Axes.set_ylim
3862-
set_ybound, get_ybound
3863-
invert_yaxis, yaxis_inverted
3862+
.Axes.set_ybound,.Axes.get_ybound
3863+
.Axes.invert_yaxis,.Axes.yaxis_inverted
38643864
38653865
Notes
38663866
-----
@@ -3909,9 +3909,9 @@ def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
39093909
39103910
See Also
39113911
--------
3912-
get_ylim
3913-
set_ybound, get_ybound
3914-
invert_yaxis, yaxis_inverted
3912+
.Axes.get_ylim
3913+
.Axes.set_ybound,.Axes.get_ybound
3914+
.Axes.invert_yaxis,.Axes.yaxis_inverted
39153915
39163916
Notes
39173917
-----
@@ -4006,7 +4006,7 @@ def format_xdata(self, x):
40064006
"""
40074007
Return *x* formatted as an x-value.
40084008
4009-
This function will use the `.fmt_xdata` attribute if it is not None,
4009+
This function will use the ``fmt_xdata`` attribute if it is not None,
40104010
else will fall back on the xaxis major formatter.
40114011
"""
40124012
return (self.fmt_xdataifself.fmt_xdataisnotNone
@@ -4016,7 +4016,7 @@ def format_ydata(self, y):
40164016
"""
40174017
Return *y* formatted as an y-value.
40184018
4019-
This function will use the `.fmt_ydata` attribute if it is not None,
4019+
This function will use the ``fmt_ydata`` attribute if it is not None,
40204020
else will fall back on the yaxis major formatter.
40214021
"""
40224022
return (self.fmt_ydataifself.fmt_ydataisnotNone

‎lib/matplotlib/backend_tools.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,9 @@ def __init__(self, *args, **kwargs):
198198
super().__init__(*args,**kwargs)
199199

200200
deftrigger(self,sender,event,data=None):
201-
"""Calls `enable` or `disable` based on `toggled` value."""
201+
"""
202+
Calls `enable` or `disable` based on `~ToolToggleBase.toggled` value.
203+
"""
202204
ifself._toggled:
203205
self.disable(event)
204206
else:
@@ -209,15 +211,15 @@ def enable(self, event=None):
209211
"""
210212
Enable the toggle tool.
211213
212-
`trigger` calls this method when `toggled` is False.
214+
`trigger` calls this method when `~ToolToggleBase.toggled` is False.
213215
"""
214216
pass
215217

216218
defdisable(self,event=None):
217219
"""
218220
Disable the toggle tool.
219221
220-
`trigger` call this method when `toggled` is True.
222+
`trigger` call this method when `~ToolToggleBase.toggled` is True.
221223
222224
This can happen in different circumstances.
223225

‎lib/matplotlib/colorbar.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,7 @@ def add_lines(self, *args, **kwargs):
762762
"""
763763
Draw lines on the colorbar.
764764
765-
The lines are appended to thelist :attr:`lines`.
765+
The lines are appended to theattribute ``lines``.
766766
767767
Parameters
768768
----------

‎lib/matplotlib/font_manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ def ttfFontProperty(font):
427427
428428
Parameters
429429
----------
430-
font : `.FT2Font`
430+
font : ``FT2Font``
431431
The TrueType font file from which information will be extracted.
432432
433433
Returns

‎lib/matplotlib/image.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ def composite_images(images, renderer, magnification=1.0):
6262
Parameters
6363
----------
6464
images : list of Images
65-
Each must have a `make_image` method. For each image,
66-
`can_composite` should return `True`, though this is not
65+
Each must have a ``make_image`` method. For each image,
66+
``can_composite`` should return `True`, though this is not
6767
enforced by this function. Each image must have a purely
6868
affine transformation with no shear.
6969

‎lib/matplotlib/legend.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
141141
142142
bbox_to_anchor : `.BboxBase`, 2-tuple, or 4-tuple of floats
143143
Box that is used to position the legend in conjunction with *loc*.
144-
Defaults to `axes.bbox` (if called as a method to `.Axes.legend`) or
145-
`figure.bbox` (if `.Figure.legend`). This argument allows arbitrary
144+
Defaults to ``axes.bbox`` (if called as a method to `.Axes.legend`) or
145+
``figure.bbox`` (if `.Figure.legend`). This argument allows arbitrary
146146
placement of the legend.
147147
148148
Bbox coordinates are interpreted in the coordinate system given by
@@ -236,8 +236,7 @@ def _update_bbox_to_anchor(self, loc_in_canvas):
236236
237237
bbox_transform : None or `matplotlib.transforms.Transform`
238238
The transform for the bounding box (*bbox_to_anchor*). For a value
239-
of ``None`` (default) the Axes'
240-
:data:`~matplotlib.axes.Axes.transAxes` transform will be used.
239+
of ``None`` (default) the Axes' ``transAxes`` transform will be used.
241240
242241
title : str or None
243242
The legend's title. Default is no title (``None``).

‎lib/matplotlib/testing/decorators.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def _cleanup_cm():
3535
@_api.deprecated("3.6",alternative="Vendor the existing code, "
3636
"including the private function _cleanup_cm.")
3737
classCleanupTestCase(unittest.TestCase):
38-
"""A wrapper for unittest.TestCase that includes cleanup operations."""
38+
"""A wrapper for`unittest.TestCase` that includes cleanup operations."""
3939
@classmethod
4040
defsetUpClass(cls):
4141
cls._cm=_cleanup_cm().__enter__()
@@ -319,7 +319,7 @@ def image_comparison(baseline_images, extensions=None, tol=0,
319319
style=("classic","_classic_test_patch")):
320320
"""
321321
Compare images generated by the test with those specified in
322-
*baseline_images*, which must correspond, else an `ImageComparisonFailure`
322+
*baseline_images*, which must correspond, else an `.ImageComparisonFailure`
323323
exception will be raised.
324324
325325
Parameters

‎lib/matplotlib/transforms.py

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ def x0(self):
253253
The first of the pair of *x* coordinates that define the bounding box.
254254
255255
This is not guaranteed to be less than :attr:`x1` (for that, use
256-
:attr:`xmin`).
256+
:attr:`~BboxBase.xmin`).
257257
"""
258258
returnself.get_points()[0,0]
259259

@@ -263,7 +263,7 @@ def y0(self):
263263
The first of the pair of *y* coordinates that define the bounding box.
264264
265265
This is not guaranteed to be less than :attr:`y1` (for that, use
266-
:attr:`ymin`).
266+
:attr:`~BboxBase.ymin`).
267267
"""
268268
returnself.get_points()[0,1]
269269

@@ -273,7 +273,7 @@ def x1(self):
273273
The second of the pair of *x* coordinates that define the bounding box.
274274
275275
This is not guaranteed to be greater than :attr:`x0` (for that, use
276-
:attr:`xmax`).
276+
:attr:`~BboxBase.xmax`).
277277
"""
278278
returnself.get_points()[1,0]
279279

@@ -283,7 +283,7 @@ def y1(self):
283283
The second of the pair of *y* coordinates that define the bounding box.
284284
285285
This is not guaranteed to be greater than :attr:`y0` (for that, use
286-
:attr:`ymax`).
286+
:attr:`~BboxBase.ymax`).
287287
"""
288288
returnself.get_points()[1,1]
289289

@@ -293,7 +293,7 @@ def p0(self):
293293
The first pair of (*x*, *y*) coordinates that define the bounding box.
294294
295295
This is not guaranteed to be the bottom-left corner (for that, use
296-
:attr:`min`).
296+
:attr:`~BboxBase.min`).
297297
"""
298298
returnself.get_points()[0]
299299

@@ -303,7 +303,7 @@ def p1(self):
303303
The second pair of (*x*, *y*) coordinates that define the bounding box.
304304
305305
This is not guaranteed to be the top-right corner (for that, use
306-
:attr:`max`).
306+
:attr:`~BboxBase.max`).
307307
"""
308308
returnself.get_points()[1]
309309

@@ -375,7 +375,10 @@ def size(self):
375375

376376
@property
377377
defbounds(self):
378-
"""Return (:attr:`x0`, :attr:`y0`, :attr:`width`, :attr:`height`)."""
378+
"""
379+
Return (:attr:`x0`, :attr:`y0`, :attr:`~BboxBase.width`,
380+
:attr:`~BboxBase.height`).
381+
"""
379382
(x0,y0), (x1,y1)=self.get_points()
380383
return (x0,y0,x1-x0,y1-y0)
381384

@@ -806,7 +809,7 @@ def from_bounds(x0, y0, width, height):
806809
@staticmethod
807810
deffrom_extents(*args,minpos=None):
808811
"""
809-
Create a new Bbox from *left*, *bottom*, *right* and *top*.
812+
Create a new`Bbox` from *left*, *bottom*, *right* and *top*.
810813
811814
The *y*-axis increases upwards.
812815
@@ -816,7 +819,7 @@ def from_extents(*args, minpos=None):
816819
The four extents of the bounding box.
817820
818821
minpos : float or None
819-
If this is supplied, the Bbox will have a minimum positive value
822+
If this is supplied, the`Bbox` will have a minimum positive value
820823
set. This is useful when dealing with logarithmic scales and other
821824
scales where negative bounds result in floating point errors.
822825
"""
@@ -1874,6 +1877,18 @@ def inverted(self):
18741877
self._invalid=0
18751878
returnself._inverted
18761879

1880+
defget_matrix(self):
1881+
"""
1882+
Get the underlying transformation matrix as a 3x3 numpy array::
1883+
1884+
a c e
1885+
b d f
1886+
0 0 1
1887+
1888+
.
1889+
"""
1890+
raiseNotImplementedError('get_matrix must be implemented by subclass')
1891+
18771892

18781893
classAffine2D(Affine2DBase):
18791894
"""
@@ -1921,15 +1936,7 @@ def from_values(a, b, c, d, e, f):
19211936
np.array([a,c,e,b,d,f,0.0,0.0,1.0],float).reshape((3,3)))
19221937

19231938
defget_matrix(self):
1924-
"""
1925-
Get the underlying transformation matrix as a 3x3 numpy array::
1926-
1927-
a c e
1928-
b d f
1929-
0 0 1
1930-
1931-
.
1932-
"""
1939+
# docstring inherited
19331940
ifself._invalid:
19341941
self._inverted=None
19351942
self._invalid=0

‎lib/mpl_toolkits/axes_grid1/axes_grid.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -367,11 +367,12 @@ def __init__(self, fig,
367367
Whether to create a colorbar for "each" axes, a "single" colorbar
368368
for the entire grid, colorbars only for axes on the "edge"
369369
determined by *cbar_location*, or no colorbars. The colorbars are
370-
stored in the:attr:`cbar_axes` attribute.
370+
stored in the``cbar_axes`` attribute.
371371
cbar_location : {"left", "right", "bottom", "top"}, default: "right"
372372
cbar_pad : float, default: None
373373
Padding between the image axes and the colorbar axes.
374-
cbar_size : size specification (see `.Size.from_any`), default: "5%"
374+
cbar_size : size specification (see `.axes_size.from_any`), default:\
375+
"5%"
375376
Colorbar size.
376377
cbar_set_cax : bool, default: True
377378
If True, each axes in the grid has a *cax* attribute that is bound

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp