10000 DOC: Update docstring to numpy format for last few functions in transforms by TomDonoghue · Pull Request #9309 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: Update docstring to numpy format for last few functions in transforms #9309

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 3 commits into from
Oct 8, 2017
Merged

DOC: Update docstring to numpy format for last few functions in transforms #9309

merged 3 commits into from
Oct 8, 2017

Conversation

TomDonoghue
Copy link
Contributor

PR Summary

Update docs in some standalone functions in matplotlib/transforms, adding docstrings to a couple functions that didn't have them, and updating a couple others to use numpy docs standards. Updates are all documentation - no code changes.

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer
Copy link
Contributor
anntzer commented Oct 7, 2017

There are some minor markup issues. Given that everyone seems to get them wrong, I'll make a PR to document that...

@anntzer
Copy link
Contributor
anntzer commented Oct 7, 2017

but basically, see http://matplotlib.org/devdocs/devel/documenting_mpl.html#formatting (regarding backquotes)

@tacaswell tacaswell added this to the 2.1.1 (next bug fix release) milestone Oct 7, 2017
@anntzer
Copy link
Contributor
anntzer commented Oct 8, 2017

@QuLogic Can you check what's happening with circleci?
Otherwise looks good to me (conditional on PEP8 passing).

@TomDonoghue
Copy link
Contributor Author

@anntzer

Thanks for checking in on this, and the heads up on the argument syntax - I wasn't totally sure on that, and missed the note about using *.

I added links to classes too, and then last commit is just a updating link to class in local file, because I wasn't sure if that had something to do with CircleCI failing (not sure what's going on there)

@anntzer
Copy link
Contributor
anntzer commented Oct 8, 2017

Circleci failing is certainly independent of your patch, but we may as well try to figure out what's happening. I'll wait for someone else to check on that before merging mostly so that that problem doesn't get lost but otherwise the PR looks good.
Thanks a lot for fixing the markup, it's a bit tedious because everyone starts by confusing with the markdown syntax but it's actually different :-)

@QuLogic
Copy link
Member
QuLogic commented Oct 8, 2017

There seems to be something up with the Debian mirrors. Previously, it was throwing 404 for packages, and the rebuild is now throwing 503 Quorum weight not reached. I'm not sure if we can really do anything; it might eventually fix itself once it reaches quorum.

@anntzer anntzer merged commit 5645f24 into matplotlib:master Oct 8, 2017
@anntzer
Copy link
Contributor
anntzer commented Oct 8, 2017

Congrats on your first contribution, hoping to see you around again!

@lumberbot-app
Copy link
lumberbot-app bot commented Oct 8, 2017

Oops, something went wrong applying the patch... Please have a look at my logs.

@anntzer
Copy link
Contributor
anntzer commented Oct 8, 2017

@Carreau where are the logs? (may be worth at least mentioning in the meeseeksdev README)

@QuLogic
Copy link
Member
QuLogic commented Oct 8, 2017

The build worked on master, so it seems the CircleCI issues fixed themselves.

@TomDonoghue TomDonoghue deleted the transforms_docs branch October 8, 2017 07:33
@tacaswell
Copy link
Member

meeseekdev seems to not work with squash-merge.

tacaswell pushed a commit that referenced this pull request Oct 8, 2017
@TomDonoghue @tacaswell
DOC: Update docstring to numpy format for last few functions in trans…
8f9a208 
…forms (#9309)

* DOC: Update docstring to numpy format for last few functions

* DOC: fix syntax for arguments, add class links, improve wording.

* DOC: Update link to class in local file
@tacaswell
Copy link
Member

backported to v2.1.x as 8f9a208

Thanks @TomDonoghue !

@Carreau
Copy link
Contributor
Carreau commented Oct 8, 2017

@Carreau where are the logs? (may be worth at least mentioning in the meeseeksdev README)

Only owner of the app can see logs (for security reason, in case a Token get leaked in the stack trace), otherwise they are here

@tacaswell is right it only works for merge commits; also I'm happy to give other admin right on heroku to be able to see logs.

Oct 07 23:44:20 meeseeksbot app/web.1: Cherry-picking 5645f24e5e0b92a8ece7cae76a2a4dd67f59e0a6 
Oct 07 23:44:20 meeseeksbot app/web.1:   stderr: 'error: Mainline was specified but commit 5645f24e5e0b92a8ece7cae76a2a4dd67f59e0a6 is not a merge. 
Oct 07 23:44:20 meeseeksbot app/web.1: fatal: cherry-pick failed'

We should allow backport of squashed commits; it should not be too hard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v2.1.1
Development

Successfully merging this pull request may close these issues.
5 participants
@TomDonoghue @anntzer @QuLogic @tacaswell @Carreau
0