8000 DOC: numpydoc-ify date Locator classes by QuLogic · Pull Request #23438 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: numpydoc-ify date Locator classes #23438

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 19, 2022
Merged

DOC: numpydoc-ify date Locator classes #23438

merged 1 commit into from
Jul 19, 2022

Conversation

QuLogic
Copy link
Member
@QuLogic QuLogic commented Jul 17, 2022

PR Summary

Also, fixes #15710

PR Checklist

Tests and Styling

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [n/a] New features are documented, with examples if plot related.
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@oscargus oscargus added this to the v3.5-doc milestone Jul 19, 2022
@oscargus oscargus merged commit 51ce677 into matplotlib:main Jul 19, 2022
@lumberbot-app
Copy link
lumberbot-app bot commented Jul 19, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 51ce6776b1a9089295652fe91567e0c814f3f95f
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #23438: DOC: numpydoc-ify date Locator classes'
  1. Push to a named branch:
git push YOURFORK v3.5.x:auto-backport-of-pr-23438-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR #23438 on branch v3.5.x (DOC: numpydoc-ify date Locator classes)"

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 Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@lumberbot-app
Copy link
lumberbot-app bot commented Jul 19, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.2-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 51ce6776b1a9089295652fe91567e0c814f3f95f
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #23438: DOC: numpydoc-ify date Locator classes'
  1. Push to a named branch:
git push YOURFORK v3.5.2-doc:auto-backport-of-pr-23438-on-v3.5.2-doc
  1. Create a PR against branch v3.5.2-doc, I would have named this PR:

"Backport PR #23438 on branch v3.5.2-doc (DOC: numpydoc-ify date Locator classes)"

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 Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@oscargus
Copy link
Member

Maybe not worthwhile to backport? (Or maybe it should not?)

oscargus pushed a commit to oscargus/matplotlib that referenced this pull request Jul 20, 2022
@QuLogic @oscargus
DOC: numpydoc-ify date Locator classes (matplotlib#23438)
9d6a058 
Also, fixes matplotlib#15710
@QuLogic
Copy link
Member Author
QuLogic commented Jul 20, 2022

.py files should not be backported to -doc branches; I guess it could go to v3.5.x, but I'm a bit lazy.

@QuLogic QuLogic deleted the date-docs branch July 20, 2022 21:49
@QuLogic QuLogic modified the milestones: v3.5-doc, v3.6.0 Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oscargus oscargus oscargus approved these changes

Assignees
No one assigned
Labels
Documentation topic: date handling
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.

doc for type of tz parameter is inconsistent throughout dates.py
2 participants
@QuLogic @oscargus
0