Skip to content

Commit ff9d2a5

Browse files
committed
Fix some missing references.
1 parent dd15dc0 commit ff9d2a5

File tree

17 files changed

+63
-179
lines changed

17 files changed

+63
-179
lines changed

doc/api/axis_api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,10 @@ Data and view intervals
121121

122122
Axis.get_data_interval
123123
Axis.get_view_interval
124+
Axis.get_inverted
124125
Axis.set_data_interval
125126
Axis.set_view_interval
127+
Axis.set_inverted
126128

127129
Rendering helpers
128130
-----------------

doc/api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ Matplotlib consists of the following submodules:
119119
texmanager_api.rst
120120
textpath_api.rst
121121
ticker_api.rst
122+
tight_bbox_api.rst
122123
tight_layout_api.rst
123124
transformations.rst
124125
tri_api.rst

doc/api/prev_api_changes/api_changes_3.1.0.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Previously, certain locator classes (`~.ticker.LogLocator`,
7474
tick locations that collided with major ticks when they were used as
7575
minor locators. This logic has now moved to the `~.axis.Axis` class,
7676
and is used regardless of the locator class. You can control this
77-
behavior via the `~.Axis.remove_overlaping_locs` attribute on
77+
behavior via the `~.Axis.remove_overlapping_locs` attribute on
7878
`~.axis.Axis`.
7979

8080
If you were relying on both the major and minor tick labels to appear
@@ -236,18 +236,18 @@ Input that consists of multiple empty lists will now return a list of histogram
236236
values for each one of the lists. For example, an input of ``[[],[]]`` will
237237
return 2 lists of histogram values. Previously, a single list was returned.
238238

239-
`.backend_bases.Timer.remove_callback` future signature change
240-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
239+
``backend_bases.TimerBase.remove_callback`` future signature change
240+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
241241

242-
Currently, ``backend_bases.Timer.remove_callback(func, *args,
242+
Currently, ``backend_bases.TimerBase.remove_callback(func, *args,
243243
**kwargs)`` removes a callback previously added by
244244
``backend_bases.Timer.add_callback(func, *args, **kwargs)``, but if
245-
``*args, **kwargs`` is not passed in (ex,
246-
``Timer.remove_callback(func)``), then the first callback with a
245+
``*args, **kwargs`` is not passed in (i.e.,
246+
``TimerBase.remove_callback(func)``), then the first callback with a
247247
matching ``func`` is removed, regardless of whether it was added with
248248
or without ``*args, **kwargs``.
249249

250-
In a future version, ``Timer.remove_callback`` will always use the latter
250+
In a future version, `.TimerBase.remove_callback` will always use the latter
251251
behavior (not consider ``*args, **kwargs``); to specifically consider them, add
252252
the callback as a `functools.partial` object ::
253253

@@ -256,7 +256,7 @@ the callback as a `functools.partial` object ::
256256
# later
257257
timer.remove_callback(cb)
258258

259-
`.backend_bases.Timer.add_callback` was modified to return *func* to
259+
`.TimerBase.add_callback` was modified to return *func* to
260260
simplify the above usage (previously it returned None); this also
261261
allows using it as a decorator.
262262

@@ -279,7 +279,7 @@ be set to `True` ::
279279

280280
Individual line segments can be extracted from the
281281
`~.collections.LineCollection` using
282-
`~.collections.LineCollection.get_segements()`. See the
282+
`~.collections.LineCollection.get_segments()`. See the
283283
`~.collections.LineCollection` documentation for other methods to
284284
retrieve the collection properties.
285285

@@ -796,10 +796,10 @@ Changes in parameter names
796796
- The *s* parameter to `.Annotation` (and indirectly `.Axes.annotate`) has
797797
been renamed to *text*.
798798
- The *tolerence* parameter to
799-
`bezier.find_bezier_t_intersecting_with_closedpath`,
800-
`bezier.split_bezier_intersecting_with_closedpath`,
801-
`bezier.find_r_to_boundary_of_closedpath`,
802-
`bezier.split_path_inout` and `bezier.check_if_parallel` has been renamed to
799+
`.bezier.find_bezier_t_intersecting_with_closedpath`,
800+
`.bezier.split_bezier_intersecting_with_closedpath`,
801+
``bezier.find_r_to_boundary_of_closedpath``,
802+
`.bezier.split_path_inout` and `.bezier.check_if_parallel` has been renamed to
803803
*tolerance*.
804804

805805
In each case, the old parameter name remains supported (it cannot be used
@@ -961,11 +961,11 @@ GUI / backend details
961961

962962
- ``.get_py2exe_datafiles``
963963
- ``.tk_window_focus``
964-
- `.backend_gtk3.FileChooserDialog`
965-
- `.backend_gtk3.NavigationToolbar2GTK3.get_filechooser`
966-
- `.backend_gtk3.SaveFigureGTK3.get_filechooser`
967-
- `.NavigationToolbar2QT.adj_window` attribute. This is unused and always ``None``.
968-
- `.backend_wx.IDLE_DELAY` global variable
964+
- ``.backend_gtk3.FileChooserDialog``
965+
- ``.backend_gtk3.NavigationToolbar2GTK3.get_filechooser``
966+
- ``.backend_gtk3.SaveFigureGTK3.get_filechooser``
967+
- ``.NavigationToolbar2QT.adj_window`` attribute. This is unused and always ``None``.
968+
- ``.backend_wx.IDLE_DELAY`` global variable
969969
This is unused and only relevant to the now removed wx "idling" code (note that
970970
as it is a module-level global, no deprecation warning is emitted when
971971
accessing it).
@@ -1021,7 +1021,7 @@ Use `~.path.get_path_collection_extents` instead.
10211021

10221022
Use ``not np.isfinite(path.vertices).all()`` instead.
10231023

1024-
- `.bezier.find_r_to_boundary_of_closedpath` function is deprecated
1024+
- ``.bezier.find_r_to_boundary_of_closedpath`` function is deprecated
10251025

10261026
This has always returned None instead of the requested radius.
10271027

doc/api/tight_bbox_api.rst

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

0 commit comments

Comments
 (0)