Skip to content

add explanations and examples to the docstring of violinplot #12585

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

Closed
wants to merge 3 commits into from
Closed

add explanations and examples to the docstring of violinplot #12585

wants to merge 3 commits into from

Conversation

andreawwenyi
Copy link

Add explanations and examples to the docstring of violinplot to explain how violinplot handles differently w.r.t. sequence of vectors and 2D array.
Closes #12178

PR Summary

PR Checklist

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

…in the difference between passing an array and passing a sequences of vectors.
Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I'm thinking you can condense this information a bit into one note.

@story645
Copy link
Member

Hi @wywang-nyu, this PR is very welcome and thank you for making it. Do you plan on making the requested changes?

Copy link
Author

@andreawwenyi andreawwenyi left a comment

Choose a reason for hiding this comment

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

delete this explanation as it is already in the note

@andreawwenyi
Copy link
Author

Hi @wywang-nyu, this PR is very welcome and thank you for making it. Do you plan on making the requested changes?

Hi, sorry for the delay! I totally forgot about this. I just made the request changes, please review! Thank you.

dataset : Array or a sequence of vectors.
The input data.
dataset : 2D Array/Matrix or a sequence of vectors.
The input data.
Copy link
Member

Choose a reason for hiding this comment

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

don't need "the input data". Notes about data haven't been moved to notes section"

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

flake8 complains (see also the flake8 Travis CI build):

./lib/matplotlib/axes/_axes.py:7874:80: E501 line too long (133 > 79 characters)
./lib/matplotlib/axes/_axes.py:7880:26: W291 trailing whitespace
./lib/matplotlib/axes/_axes.py:7881:80: E501 line too long (116 > 79 characters)
./lib/matplotlib/axes/_axes.py:7882:80: E501 line too long (108 > 79 characters)
3     E501 line too long (133 > 79 characters)
1     W291 trailing whitespace

Please fix to comply with our coding conventions.

@story645
Copy link
Member

story645 commented Nov 1, 2019

closing because this got kind of addressed in #14107 but will totally reopen if @andrea-w-wang has the bandwidth to readdress this.

@story645 story645 closed this Nov 1, 2019
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.

Violin plot inconsistency between list and numpy
3 participants