Repository navigation
Commit ee4f8c7
committed
Make functions param to secondary_x/yaxis not keyword-only.
I suspect the parameter was made keyword-only because the originally
planned signature was `secondary_xaxis(location, forward=...,
inverse=...)` where the keywords actually add some semantics (though
that signature overall seems worse); however, for a single `functions`
parameter, having to type an extra `functions=` in the call doesn't help
the reader much (either they know what secondary_x/yaxis does, in which
case the explicit kwarg doesn't matter, or they don't, in which case the
kwarg name hardly helps)... and is a bit annoying. See the modified
gallery entry, for example.1 parent eb62d69 commit ee4f8c7
2 files changed
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -496,7 +496,7 @@ def my_plotter(ax, data1, data2, param_dict): | |||
| 496 | 496 | ||
| 497 | 497 | ax3.plot(t, s) | |
| 498 | 498 | ax3.set_xlabel('Angle [rad]') | |
| 499 | - ax4 = ax3.secondary_xaxis('top', functions=(np.rad2deg, np.deg2rad)) | ||
| 499 | + ax4 = ax3.secondary_xaxis('top', (np.rad2deg, np.deg2rad)) | ||
| 500 | 500 | ax4.set_xlabel('Angle [°]') | |
| 501 | 501 | ||
| 502 | 502 | # %% | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -570,7 +570,7 @@ def indicate_inset_zoom(self, inset_ax, **kwargs): | |||
| 570 | 570 | return self.indicate_inset(rect, inset_ax, **kwargs) | |
| 571 | 571 | ||
| 572 | 572 | @_docstring.dedent_interpd | |
| 573 | - def secondary_xaxis(self, location, *, functions=None, transform=None, **kwargs): | ||
| 573 | + def secondary_xaxis(self, location, functions=None, *, transform=None, **kwargs): | ||
| 574 | 574 | """ | |
| 575 | 575 | Add a second x-axis to this `~.axes.Axes`. | |
| 576 | 576 | ||
@@ -624,7 +624,7 @@ def invert(x): | |||
| 624 | 624 | return secondary_ax | |
| 625 | 625 | ||
| 626 | 626 | @_docstring.dedent_interpd | |
| 627 | - def secondary_yaxis(self, location, *, functions=None, transform=None, **kwargs): | ||
| 627 | + def secondary_yaxis(self, location, functions=None, *, transform=None, **kwargs): | ||
| 628 | 628 | """ | |
| 629 | 629 | Add a second y-axis to this `~.axes.Axes`. | |
| 630 | 630 | ||
0 commit comments