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.

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

Reword a bit the contour docs. #12897

Merged
merged 1 commit into from Nov 27, 2018
Merged

Reword a bit the contour docs. #12897

merged 1 commit into from Nov 27, 2018

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Nov 27, 2018

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 added this to the v3.1 milestone Nov 27, 2018
anntzer
anntzer commented Nov 27, 2018
View reviewed changes
lib/matplotlib/contour.py
filled contours, respectively. Except as noted, function
signatures and return values are the same for both versions.

`.contour` and `.contourf` draw contour lines and filled contours,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This should make Axes.contour point to Axes.contourf and pyplot.contour point to pyplot.contourf.

timhoffm
timhoffm approved these changes Nov 27, 2018
View reviewed changes
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.

There's still a lot to do on the arguments description. Approving as an incremental improvement.

@jklymak jklymak merged commit d42a0a8 into matplotlib:master Nov 27, 2018
@anntzer anntzer deleted the contour-docs branch November 27, 2018 21:18
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.

None yet
3 participants
@anntzer @timhoffm @jklymak