NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

Commit9acea51

committed

simplify docstrings

1 parentca844fd commit9acea51Copy full SHA for 9acea51

File tree

2 files changed

+17

-45

lines changed

lib/matplotlib
- axis.py
- tests
  - test_axes.py

2 files changed

+17

-45

lines changed

`‎lib/matplotlib/axis.py`

Lines changed: 1 addition & 37 deletions

Original file line number	Diff line number	Diff line change
`@@ -1549,19 +1549,7 @@ def set_minor_formatter(self, formatter):`
`1549`	`1549`
`1550`	`1550`	In addition to a `~matplotlib.ticker.Formatter` instance,
`1551`	`1551`	this also accepts a ``str`` or function.
`1552`		`-`
`1553`		- For a ``str`` a `~matplotlib.ticker.StrMethodFormatter` is used.
`1554`		- The field used for the value must be labeled ``'x'`` and the field used
`1555`		- for the position must be labeled ``'pos'``.
`1556`		- See the `~matplotlib.ticker.StrMethodFormatter` documentation for
`1557`		`- more information.`
`1558`		`-`
`1559`		- For a function a `~matplotlib.ticker.FuncFormatter` is used.
`1560`		- The function should take in two inputs (a tick value ``x`` and a
`1561`		- position ``pos``), and return a string containing the corresponding
`1562`		`- tick label.`
`1563`		- See the `~matplotlib.ticker.FuncFormatter` documentation for
`1564`		`- more information.`
	`1552`	+ See `.Axis.set_major_formatter` for more information.
`1565`	`1553`
`1566`	`1554`	`Parameters`
`1567`	`1555`	`----------`
`@@ -1570,30 +1558,6 @@ def set_minor_formatter(self, formatter):`
`1570`	`1558`	`self._set_formatter(formatter,self.minor)`
`1571`	`1559`
`1572`	`1560`	`def_set_formatter(self,formatter,level):`
`1573`		`-"""`
`1574`		`- Set the formatter of the major or minor ticker.`
`1575`		`-`
`1576`		- In addition to a `~matplotlib.ticker.Formatter` instance,
`1577`		- this also accepts a ``str`` or function.
`1578`		`-`
`1579`		- For a ``str`` a `~matplotlib.ticker.StrMethodFormatter` is used.
`1580`		- The field used for the value must be labeled ``'x'`` and the field used
`1581`		- for the position must be labeled ``'pos'``.
`1582`		- See the `~matplotlib.ticker.StrMethodFormatter` documentation for
`1583`		`- more information.`
`1584`		`-`
`1585`		- For a function a `~matplotlib.ticker.FuncFormatter` is used.
`1586`		- The function should take in two inputs (a tick value ``x`` and a
`1587`		- position ``pos``), and return a string containing the corresponding
`1588`		`- tick label.`
`1589`		- See the `~matplotlib.ticker.FuncFormatter` documentation for
`1590`		`- more information.`
`1591`		`-`
`1592`		`- Parameters`
`1593`		`- ----------`
`1594`		- formatter : `~matplotlib.ticker.Formatter`, ``str``, or function
`1595`		- level : `self.major` or `self.minor`
`1596`		`- """`
`1597`	`1561`	`ifisinstance(formatter,str):`
`1598`	`1562`	`formatter=mticker.StrMethodFormatter(formatter)`
`1599`	`1563`	`# Don't allow any other TickHelper to avoid easy-to-make errors,`

`‎lib/matplotlib/tests/test_axes.py`

Lines changed: 16 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -210,13 +210,17 @@ def _formfunc(x, pos):`
`210`	`210`
`211`	`211`	`ax=plt.figure().subplots()`
`212`	`212`
`213`		`-assertax.xaxis.isDefault_majfmt==True`
`214`		`-assertax.xaxis.isDefault_minfmt==True`
	`213`	`+assertax.xaxis.isDefault_majfmt`
	`214`	`+assertax.xaxis.isDefault_minfmt`
	`215`	`+assertax.yaxis.isDefault_majfmt`
	`216`	`+assertax.yaxis.isDefault_minfmt`
`215`	`217`
`216`	`218`	`ax.xaxis.set_major_formatter(_formfunc)`
`217`	`219`
`218`		`-assertax.xaxis.isDefault_majfmt==False`
`219`		`-assertax.xaxis.isDefault_minfmt==True`
	`220`	`+assertnotax.xaxis.isDefault_majfmt`
	`221`	`+assertax.xaxis.isDefault_minfmt`
	`222`	`+assertax.yaxis.isDefault_majfmt`
	`223`	`+assertax.yaxis.isDefault_minfmt`
`220`	`224`
`221`	`225`	`targ_funcformatter=mticker.FuncFormatter(_formfunc)`
`222`	`226`
`@@ -231,13 +235,17 @@ def test_strmethodformatter_auto_formatter():`
`231`	`235`
`232`	`236`	`ax=plt.figure().subplots()`
`233`	`237`
`234`		`-assertax.yaxis.isDefault_majfmt==True`
`235`		`-assertax.yaxis.isDefault_minfmt==True`
	`238`	`+assertax.xaxis.isDefault_majfmt`
	`239`	`+assertax.xaxis.isDefault_minfmt`
	`240`	`+assertax.yaxis.isDefault_majfmt`
	`241`	`+assertax.yaxis.isDefault_minfmt`
`236`	`242`
`237`	`243`	`ax.yaxis.set_minor_formatter(formstr)`
`238`	`244`
`239`		`-assertax.yaxis.isDefault_majfmt==True`
`240`		`-assertax.yaxis.isDefault_minfmt==False`
	`245`	`+assertax.xaxis.isDefault_majfmt`
	`246`	`+assertax.xaxis.isDefault_minfmt`
	`247`	`+assertax.yaxis.isDefault_majfmt`
	`248`	`+assertnotax.yaxis.isDefault_minfmt`
`241`	`249`
`242`	`250`	`targ_strformatter=mticker.StrMethodFormatter(formstr)`
`243`	`251`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit9acea51

File tree

2 files changed

2 files changed

`‎lib/matplotlib/axis.py`

`‎lib/matplotlib/tests/test_axes.py`

0 commit comments