8000 numpydocify Sankey.add. by anntzer · Pull Request #13217 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

numpydocify Sankey.add. #13217

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
Jan 19, 2019
Merged

numpydocify Sankey.add. #13217

merged 1 commit into from
Jan 19, 2019

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Jan 18, 2019

Note that the previously stated default facecolor and linewidth only
apply in _internal.classic_mode, so don't need to be mentioned.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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 anntzer mentioned this pull request Jan 18, 2019
Merged
6 tasks
timhoffm
timhoffm reviewed Jan 18, 2019
View reviewed changes
lib/matplotlib/sankey.py Outdated
----------
patchlabel : str
Label to be placed at the center of the diagram.
Note that *label* (not *patchlabel*) will be passed to the patch
Copy link
Member

Choose a reason for hiding this comment

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

Simpler: Note that label (not patchlabel) can be passed as kwarg to create an entry in the legend.

lib/matplotlib/sankey.py Outdated
outputs are negative.

The flows are placed along the top of the diagram from the inside
out in order of their index within the *flows* list or array. They
Copy link
Member

Choose a reason for hiding this comment

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

Simpler: ...within flows.

lib/matplotlib/sankey.py Outdated
shown, regardless of the value of this argument.

trunklength : float
Length between the bases of the input and output groups.
Copy link
Member

Choose a reason for hiding this comment

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

Can you give a unit?

@anntzer
Copy link
Contributor Author
anntzer commented Jan 19, 2019

Thanks, all comments handled.

timhoffm
timhoffm reviewed Jan 19, 2019
View reviewed changes
@anntzer
numpydocify Sankey.add.
7e474da 
Note that the previously stated default facecolor and linewidth only
apply in _internal.classic_mode, so don't need to be mentioned.
@anntzer
Copy link
Contributor Author
anntzer commented Jan 19, 2019

Good to merge? :)

@timhoffm
Copy link
Member

Oh, yes. I‘m always thinking of two reviews. But this is just documentation, for which one review is sufficient.

@timhoffm timhoffm merged commit b9ae659 into matplotlib:master Jan 19, 2019
@anntzer anntzer deleted the sankey-doc branch January 19, 2019 15:14
@QuLogic QuLogic added this to the v3.1 milestone Jan 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.1.0
Development

Successfully merging this pull request may close these issues.
3 participants
@anntzer @timhoffm @QuLogic
0