Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC : fixes small typos in matplotlib.dates docs #2725

Merged
merged 1 commit into from Jan 13, 2014

Conversation

tacaswell
Copy link
Member

  • added explicit import for day of week alias
  • fixed dateutils -> dateutil type

closes issue #2724

@@ -50,6 +50,9 @@
Most of the date tickers can locate single or multiple values. For
example::

# import constants for the days of the week
from dateutil.rrule import MO, TU, WE, TH, FR, SA, SU
Copy link
Member

Choose a reason for hiding this comment

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

Putting this import in the example is harmless, but a little odd, because all of these symbols are already imported by dates into its namespace. The user shouldn't have to know about rrule at all.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fair enough, I just went with the route that the OP had talked about. I will change it so that it imports from mdates instead.

@tacaswell
Copy link
Member Author

@efiring tweaked and force updated

@@ -1028,7 +1031,8 @@ def __init__(self, byweekday=1, interval=1, tz=None):
sequence.

Elements of *byweekday* must be one of MO, TU, WE, TH, FR, SA,
SU, the constants from :mod:`dateutils.rrule`.
SU, the constants from :mod:`dateutil.rrule`, which have been
imported into the `matplotilb.dates` namespace.
Copy link
Member

Choose a reason for hiding this comment

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

Typo. And I suppose you might as well use the :mod: prefix here also.

@tacaswell
Copy link
Member Author

lets try this one more time....

efiring added a commit that referenced this pull request Jan 13, 2014
DOC : fixes small typos in matplotlib.dates docs
@efiring efiring merged commit fc07202 into matplotlib:master Jan 13, 2014
 - added explicit import for day of week alias
 - fixed dateutils -> dateutil type

closes issue matplotlib#2724
@tacaswell tacaswell deleted the dates_doc_update branch January 13, 2014 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants