Skip to content

added parameter documentation for MultiCursor - #21492

Merged
QuLogic merged 2 commits into
matplotlib:mainfrom
FelixNoessler:multicursor_doc
Oct 29, 2021
Merged

QuLogic merged 2 commits into
matplotlib:mainfrom
FelixNoessler:multicursor_doc

Conversation

@FelixNoessler

@FelixNoessler FelixNoessler commented Oct 28, 2021 •

Copy link
Copy Markdown
Contributor

PR Summary

fixes #19634

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

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.

@QuLogic QuLogic added this to the v3.5.0 milestone Oct 29, 2021
@QuLogic
QuLogic merged commit fc69a38 into matplotlib:main Oct 29, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 29, 2021
@QuLogic

QuLogic commented Oct 29, 2021

Copy link
Copy Markdown
Member

Thanks @FelixNoessler! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again.

timhoffm added a commit that referenced this pull request Oct 29, 2021
…492-on-v3.5.x

Backport PR #21492 on branch v3.5.x (added parameter documentation for MultiCursor)
@FelixNoessler
FelixNoessler deleted the multicursor_doc branch November 9, 2021 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation mentored: sprint Issues intended and suitable for sprints topic: widgets/UI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Multicursor docstring missing a Parameters Section

2 participants