Skip to content

DOC: align contour parameter doc with implementation #24130

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

Merged
merged 1 commit into from
Oct 9, 2022

Conversation

martok
Copy link
Contributor

@martok martok commented Oct 8, 2022

PR Summary

Issue #24121.

The docstrings implied a functionality that does not exist and never has, this PR updates to what actually happens.

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).

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

Copy link
Member

@oscargus oscargus left a comment

Choose a reason for hiding this comment

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

Looks good, thanks! I'll wait for someone else to double check that it is indeed as we both think.

@oscargus oscargus added this to the v3.6.2 milestone Oct 8, 2022
@timhoffm timhoffm merged commit 834c89c into matplotlib:main Oct 9, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 9, 2022
@timhoffm
Copy link
Member

timhoffm commented Oct 9, 2022

Thanks @martok, and congratulations on your first contribution to Matplotlib. We’d be happy to see you back.

oscargus added a commit that referenced this pull request Oct 10, 2022
…130-on-v3.6.x

Backport PR #24130 on branch v3.6.x (DOC: align contour parameter doc with implementation)
@ksunden ksunden mentioned this pull request Feb 20, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants