DOC: Improve readability of date formatters/locators example #26254
Conversation
| @@ -55,13 +34,42 @@ def plot_axis(ax, locator=None, xmax='2002-02-01', fmt=None, formatter=None): | |||
| ax.text(0.0, 0.2, locator or formatter, transform=ax.transAxes, | |||
| fontsize=14, fontname='Monospace', color='tab:blue') | |||
|
|
|||
| # %% | |||
| # :ref:`Date locators <date-tickers>` (also known as tickers) | |||
There was a problem hiding this comment.
| # :ref:`Date locators <date-tickers>` (also known as tickers) | |
| # :ref:`Date locators <date-tickers>` |
Since they're locator objects, I think the also known as adds more confusion than clarity.
There was a problem hiding this comment.
I added this comment because the example calls them locators but they are called tickers in the linked docs. Not sure what's the "official" name.
There was a problem hiding this comment.
Ugh , the class that manages location are the locators, the object they locate are the ticks, both Tick objects and Locators are found in the Tick module. Let me know if this is starting to feel out of scope/a different problem altogether
There was a problem hiding this comment.
So the docs should read "Most of the date tickers locators can locate single or multiple values ticks." and "The available date tickers locators are:", right? If this is the case, should this be changed in this PR or better in a seperate one (or do I still get it wrong?).
So I will remove the "(also known as tickers)".
There was a problem hiding this comment.
Yup, correct (I think) and your choice about this PR or follow on.
There was a problem hiding this comment.
let's make it a separate issue
by grouping code and output
| @@ -99,6 +99,8 @@ | |||
|
|
|||
| .. _dateutil: https://dateutil.readthedocs.io | |||
|
|
|||
| .. _date-tickers: | |||
|
|
|||
| Date tickers | |||
There was a problem hiding this comment.
This should also probably be changed to Date tick locators?
There was a problem hiding this comment.
Yes, I just named the reference after the heading, if the heading changes it would make sense to change the reference along (although technically not necessary).
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
PR summary
Improve readability of date formatters/locators example by grouping code and output.
PR checklist