Skip to content

Update some matplotlib.lines docstrings. #19751

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
Mar 21, 2021
Merged

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Mar 20, 2021

(The comment at the end regarding instance methods is completely
outdated and doesn't even match the current code anymore.)

PR Summary

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

Comment on lines 2 to 3
The 2D line class which can be drawn with a variety of line styles, markers,
colors, etc.
"""
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The 2D line class which can be drawn with a variety of line styles, markers,
colors, etc.
"""
Class for 2D lines that can be drawn with a variety of line styles, markers, colors, etc.
"""

Copy link
Contributor Author

Choose a reason for hiding this comment

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

reworded

(The comment at the end regarding instance methods is completely
outdated and doesn't even match the current code anymore.)
@story645 story645 merged commit cd31f5d into matplotlib:master Mar 21, 2021
@anntzer anntzer deleted the l2dd branch March 21, 2021 11:34
@QuLogic QuLogic added this to the v3.5.0 milestone Mar 22, 2021
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.

4 participants