Commit97390e3

committed

DOC: scales - built in options and custom usefulness

1 parentba32c7e commit97390e3Copy full SHA for 97390e3

File tree

+21

-16

lines changed

+21

-16

lines changed

Lines changed: 14 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,21 @@`
`6`	`6`	`============`
`7`	`7`
`8`	`8`	`Create a custom scale, by implementing the scaling use for latitude data in a`
`9`		`-Mercator Projection.`
	`9`	`+Mercator Projection. A custom scale is useful when`
`10`	`10`
`11`		-Unless you are making special use of the `.Transform` class, you probably
`12`		-don't need to use this verbose method, and instead can use `~.scale.FuncScale`
`13`		-and the ``'function'`` option of `~.Axes.set_xscale` and `~.Axes.set_yscale`.
`14`		-See the last example in :doc:`/gallery/scales/scales`.
	`11`	+* You are making special use of the `.Transform` class, such as the special
	`12`	+ handling of values beyond the threshold in ``MercatorLatitudeTransform``
	`13`	`+ below.`
	`14`	`+`
	`15`	`+* You want to override the default locators and formatters for the axis`
	`16`	+ (``set_default_locators_and_formatters`` below).
	`17`	`+`
	`18`	+* You want to limit the range of the the axis (``limit_range_for_scale`` below).
	`19`	`+`
	`20`	`+If you do not need any of the above, then you probably don't need to use this`
	`21`	+verbose method, and instead can use `~.scale.FuncScale` and the ``'function'``
	`22`	+option of `~.Axes.set_xscale` and `~.Axes.set_yscale`. See the last example in
	`23`	+:doc:`/gallery/scales/scales`.
`15`	`24`	`"""`
`16`	`25`
`17`	`26`	`importnumpyasnp`

Lines changed: 7 additions & 11 deletions

Original file line number	Diff line number	Diff line change
`@@ -759,26 +759,22 @@ def _set_axes_scale(self, value, **kwargs):`
`759`	`759`
`760`	`760`	`Parameters`
`761`	`761`	`----------`
`762`		- value : {"linear", "log", "symlog", "logit", ...} or `.ScaleBase`
`763`		`- The axis scale type to apply.`
	`762`	+ value : str or `.ScaleBase`
	`763`	`+ The axis scale type to apply. Supported string values are "linear", "log",`
	`764`	`+ "symlog", "logit", "function", "functionlog", "asinh", and the names of any`
	`765`	+ custom scales registered using `matplotlib.scale.register_scale`.
`764`	`766`
`765`	`767`	`**kwargs`
`766`		`-Different keyword arguments are accepted, depending onthescale.`
`767`		`-Seethe respective class keyword arguments:`
	`768`	`+If value is a string, keywords are passed totheinstantiation method of`
	`769`	`+ the respective class:`
`768`	`770`
`769`	`771`	- `matplotlib.scale.LinearScale`
`770`	`772`	- `matplotlib.scale.LogScale`
`771`	`773`	- `matplotlib.scale.SymmetricalLogScale`
`772`	`774`	- `matplotlib.scale.LogitScale`
`773`	`775`	- `matplotlib.scale.FuncScale`
	`776`	+ - `matplotlib.scale.FuncScaleLog`
`774`	`777`	- `matplotlib.scale.AsinhScale`
`775`		`-`
`776`		`- Notes`
`777`		`- -----`
`778`		`- By default, Matplotlib supports the above-mentioned scales.`
`779`		`- Additionally, custom scales may be registered using`
`780`		- `matplotlib.scale.register_scale`. These scales can then also
`781`		`- be used here.`
`782`	`778`	`"""`
`783`	`779`	`name=self._get_axis_name()`
`784`	`780`	`old_default_lims= (self.get_major_locator()`

Comments

(0)