Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a305776

Browse files
committed
Reoder Axes API docs.
The previous order was a bit of a mess. I went for set_xfoo, get_xfoo, set_yfoo, get_yfoo although set_xfoo, set_yfoo, get_xfoo, get_yfoo would probably have worked equally well.
1 parent 7f8e63a commit a305776

File tree

1 file changed

+33
-41
lines changed

1 file changed

+33
-41
lines changed

doc/api/axes_api.rst

Lines changed: 33 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -239,16 +239,16 @@ Property cycle
239239
Axis / limits
240240
=============
241241

242+
.. For families of methods of the form {get,set}_{x,y}foo, try to list them in
243+
the order set_xfoo, get_xfoo, set_yfoo, get_yfoo
244+
242245
.. autosummary::
243246
:toctree: _as_gen
244247
:template: autosummary.rst
245248
:nosignatures:
246249

247-
248-
Axes.get_yaxis
249250
Axes.get_xaxis
250-
251-
251+
Axes.get_yaxis
252252

253253
Axis Limits and direction
254254
-------------------------
@@ -259,23 +259,22 @@ Axis Limits and direction
259259
:nosignatures:
260260

261261
Axes.invert_xaxis
262-
Axes.invert_yaxis
263262
Axes.xaxis_inverted
263+
Axes.invert_yaxis
264264
Axes.yaxis_inverted
265265

266266
Axes.set_xlim
267+
Axes.get_xlim
267268
Axes.set_ylim
268269
Axes.get_ylim
269-
Axes.get_xlim
270270

271271
Axes.update_datalim
272272
Axes.update_datalim_bounds
273-
Axes.update_datalim_numerix
274273

275-
Axes.set_ybound
276274
Axes.set_xbound
277-
Axes.get_ybound
278275
Axes.get_xbound
276+
Axes.set_ybound
277+
Axes.get_ybound
279278

280279
Axis Labels, title, and legend
281280
------------------------------
@@ -285,19 +284,17 @@ Axis Labels, title, and legend
285284
:template: autosummary.rst
286285
:nosignatures:
287286

288-
Axes.get_xlabel
289-
Axes.get_ylabel
290-
291287
Axes.set_xlabel
288+
Axes.get_xlabel
292289
Axes.set_ylabel
290+
Axes.get_ylabel
293291

294292
Axes.set_title
295293
Axes.get_title
296294
Axes.legend
297295
Axes.get_legend
298296
Axes.get_legend_handles_labels
299297

300-
301298
Axis scales
302299
-----------
303300

@@ -308,11 +305,8 @@ Axis scales
308305

309306
Axes.set_xscale
310307
Axes.get_xscale
311-
312-
Axes.get_yscale
313308
Axes.set_yscale
314-
315-
309+
Axes.get_yscale
316310

317311
Autoscaling and margins
318312
-----------------------
@@ -333,15 +327,14 @@ Autoscaling and margins
333327
Axes.autoscale
334328
Axes.autoscale_view
335329

336-
Axes.get_autoscale_on
337330
Axes.set_autoscale_on
331+
Axes.get_autoscale_on
338332

339-
Axes.get_autoscalex_on
340333
Axes.set_autoscalex_on
334+
Axes.get_autoscalex_on
341335

342-
Axes.get_autoscaley_on
343336
Axes.set_autoscaley_on
344-
337+
Axes.get_autoscaley_on
345338

346339
Aspect ratio
347340
------------
@@ -352,56 +345,55 @@ Aspect ratio
352345
:nosignatures:
353346

354347
Axes.apply_aspect
355-
Axes.get_aspect
356348
Axes.set_aspect
349+
Axes.get_aspect
357350

358-
Axes.get_adjustable
359351
Axes.set_adjustable
360-
352+
Axes.get_adjustable
361353

362354
Ticks and tick labels
363355
---------------------
364356

365-
366357
.. autosummary::
367358
:toctree: _as_gen
368359
:template: autosummary.rst
369360
:nosignatures:
370361

371-
Axes.xaxis_date
372-
Axes.yaxis_date
362+
Axes.set_xticks
363+
Axes.get_xticks
373364

365+
Axes.set_xticklabels
366+
Axes.get_xticklabels
374367
Axes.get_xmajorticklabels
375368
Axes.get_xminorticklabels
376-
Axes.get_xticklabels
369+
370+
Axes.get_xgridlines
377371
Axes.get_xticklines
378-
Axes.get_xticks
379372

380-
Axes.get_ymajorticklabels
381-
Axes.get_yminorticklabels
382-
Axes.get_yticklabels
383-
Axes.get_yticklines
384-
Axes.get_yticks
373+
Axes.xaxis_date
385374

386-
Axes.minorticks_off
387-
Axes.minorticks_on
375+
Axes.set_yticks
376+
Axes.get_yticks
388377

389-
Axes.set_xticklabels
390-
Axes.set_xticks
391378
Axes.set_yticklabels
392-
Axes.set_yticks
379+
Axes.get_yticklabels
380+
Axes.get_ymajorticklabels
381+
Axes.get_yminorticklabels
393382

394-
Axes.get_xgridlines
395383
Axes.get_ygridlines
384+
Axes.get_yticklines
385+
386+
Axes.yaxis_date
396387

388+
Axes.minorticks_off
389+
Axes.minorticks_on
397390

398391
Axes.ticklabel_format
399392
Axes.tick_params
400393

401394
Axes.locator_params
402395

403396

404-
405397
Units
406398
=====
407399

0 commit comments

Comments
 (0)