8000 Move AxisArtistHelpers to toplevel. · matplotlib/matplotlib@26773fb · GitHub
[go: up one dir, main page]
Skip to content

Commit 26773fb

Browse files
anntzeranntzer
committed
Move AxisArtistHelpers to toplevel.
The axisartist has a concept of "axis_artist_helper", which computes various computations to draw slanted/curved axises. Confusingly, `AxisArtistHelper` (and likewise `AxisArtistHelperRectlinear`) do *not* define such helper classes; they are simply namespaces that hold the `{AxisArtistHelper,AxisArtistHelperRectlinear}.{Fixed,Floating}` nested classes which *do* define helpers. More specifically, `AxisArtistHelper.{Fixed,Floating}` act as abstract base classes for `AxisArtistHelperRectlinear.{Fixed,Floating}` which are actually usable. In order to slightly disentangle this move the actual helper classes to the toplevel (as `_{Fixed,Floating}AxisArtistHelperBase` and `_{Fixed,Floating}AxisArtistHelperRectlinear`), keeping the old "purely namespace" classes around for backcompat. (But note that end users should never have to directly interact with these classes anyways -- normally, they only construct GridHelpers which take care of the interaction with AxisArtistHelpers; see e.g. the various axisartist examples.) More simply, this commit simply dedents most of the definitions of the Helper classes.
1 parent 7103779 commit 26773fb

File tree

3 files changed

+204
-187
lines changed

3 files changed

+204
-187
lines changed

‎doc/missing-references.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,8 +277,15 @@
277277
"mpl_toolkits.axisartist.axisline_style._FancyAxislineStyle.SimpleArrow": [
278278
"lib/mpl_toolkits/axisartist/axisline_style.py:docstring of mpl_toolkits.axisartist.axisline_style.AxislineStyle:1"
279279
],
280-
"mpl_toolkits.axisartist.axislines.AxisArtistHelper._Base": [
281-
"lib/mpl_toolkits/axisartist/axislines.py:docstring of mpl_toolkits.axisartist.axislines.AxisArtistHelper:1"
280+
"mpl_toolkits.axisartist.axislines._FixedAxisArtistHelperBase": [
281+
"lib/mpl_toolkits/axisartist/axislines.py:docstring of mpl_toolkits.axisartist.axislines.AxisArtistHelper:1",
282+
"lib/mpl_toolkits/axisartist/axislines.py:docstring of mpl_toolkits.axisartist.axislines.FixedAxisArtistHelperRectilinear:1",
283+
"lib/mpl_toolkits/axisartist/grid_helper_curvelinear.py:docstring of mpl_toolkits.axisartist.grid_helper_curvelinear.FixedAxisArtistHelper:1"
284+
],
285+
"mpl_toolkits.axisartist.axislines._FloatingAxisArtistHelperBase": [
286+
"lib/mpl_toolkits/axisartist/axislines.py:docstring of mpl_toolkits.axisartist.axislines.AxisArtistHelper:1",
287+
"lib/mpl_toolkits/axisartist/axislines.py:docstring of mpl_toolkits.axisartist.axislines.FloatingAxisArtistHelperRectilinear:1",
288+
"lib/mpl_toolkits/axisartist/grid_helper_curvelinear.py:docstring of mpl_toolkits.axisartist.grid_helper_curvelinear.FloatingAxisArtistHelper:1"
282289
],
283290
"mpl_toolkits.axisartist.floating_axes.FloatingAxesHostAxes": [
284291
"doc/api/_as_gen/mpl_toolkits.axisartist.floating_axes.rst:32:<autosummary>:1",

0 commit comments

Comments
 (0)
0