Skip to content

Convert tick-setting methods to docstrings - #9192

Merged
NelleV merged 2 commits into
matplotlib:masterfrom
dstansby:set-tick-docstrings
Sep 19, 2017
Merged

NelleV merged 2 commits into
matplotlib:masterfrom
dstansby:set-tick-docstrings

Conversation

@dstansby

Copy link
Copy Markdown
Member

No description provided.

Sequence of ticks

minor : bool, optional
If ``False`` sets major ticks, if ``True`` sets minor ticks.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this can also take the string 'both'.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on second thought, that makes not much sense for this set_ method.

Comment thread lib/matplotlib/axes/_base.py Outdated
Returns
-------
labels : list
List of :class:`~matplotlib.text.Text` instancess

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"instacesssss"

Comment thread lib/matplotlib/axes/_base.py Outdated
Parameters
----------
ticks : sequence
Sequence of ticks

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would just say list... and list of floats (I guess?), as it's not a list of Tick objects (unless I got this completely wrong).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be a list of datetimes if it's a date axis?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly, no idea.
But "ticks" without further qualification definitely sounds like "Tick objects" to me.

@NelleV
NelleV merged commit 0817c66 into matplotlib:master Sep 19, 2017
@dstansby
dstansby deleted the set-tick-docstrings branch September 19, 2017 18:25
@dstansby dstansby added this to the 2.1 (next point release) milestone Sep 19, 2017
dstansby pushed a commit that referenced this pull request Sep 19, 2017
Convert tick-setting methods to docstrings
@dstansby

Copy link
Copy Markdown
Member Author

Backported to 2.1.x via. 172daf8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants