Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Update description of properties of Line2D in 'plot' documentation. #14741

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
Merged
merged 2 commits into from
Jul 14, 2019
Merged

DOC: Update description of properties of Line2D in 'plot' documentation. #14741

merged 2 commits into from
Jul 14, 2019

Conversation

sameshl
Copy link
Contributor

@sameshl sameshl commented Jul 11, 2019

Line2D properties on plot documentation had only mentioned property value to be float and had not given any info on unit used.
Added info on unit used for properties is points.

closes #14720

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

@sameshl
DOC: Update description of properties of Line2D in 'plot' documentation.
34e1459 
Line2D properties on plot documentation had only mentioned property value to be float and had not given any info on unit used.
Added info on unit used for properties is points.

closes #14720
@jklymak
Copy link
Member

jklymak commented Jul 11, 2019

Note this does not close #14720 which is for the kwarg list that gets repeated in other methods that use Line2d

@sameshl
Copy link
Contributor Author

sameshl commented Jul 11, 2019

I see. My bad. Can you help me understand where I would have to make changes so I can fix it for other methods that use Line2D

@timhoffm
Copy link
Member

See lines.py l.1528 and the methods used therein for the docstring generation mechanism.

docstring.interpd.update(_Line2D_docstr=artist.kwdoc(Line2D))

@sameshl
Copy link
Contributor Author

sameshl commented Jul 13, 2019 •
edited
Loading

@timhoffm I looked into https://github.com/matplotlib/matplotlib/blob/master/doc/devel/documenting_mpl.rst#keyword-arguments . And by the given code example there, it looks like any changes made in the docstrings of Line2D will get reflected in all the methods use Line2D due to underlying function matplotlib.artist.kwdoc and the decorator
matplotlib.docstring.dedent_interpd.

@dstansby dstansby added this to the v3.1.2 milestone Jul 13, 2019
dstansby
dstansby approved these changes Jul 13, 2019
View reviewed changes
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

Looks 👍 to me, thanks for the PR

@sameshl
Copy link
Contributor Author

sameshl commented Jul 13, 2019

@dstansby Thank you! Looking forward to more contributions to this organization. 😃

@timhoffm timhoffm merged commit d21f1ca into matplotlib:master Jul 14, 2019
@timhoffm
Copy link
Member

Thanks, and congratulations on your first contribution to Matplotlib! Hope to see you back sometime. 😄

@sameshl sameshl deleted the update_plot_doc branch July 14, 2019 12:00
@QuLogic
Copy link
Member

QuLogic commented Jul 17, 2019

@meeseeksdev backport to v3.1.x

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jul 17, 2019
@timhoffm
Backport PR matplotlib#14741: DOC: Update description of properties o…
6da0a6b 
…f Line2D in 'plot' documentation.
@meeseeksmachine meeseeksmachine mentioned this pull request Jul 17, 2019
Merged
tacaswell added a commit that referenced this pull request Jul 17, 2019
@tacaswell
Merge pull request #14821 from meeseeksmachine/auto-backport-of-pr-14…
7ecd4b9 
…741-on-v3.1.x

Backport PR #14741 on branch v3.1.x (DOC: Update description of properties of Line2D in 'plot' documentation.)
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

@dstansby dstansby dstansby approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.1.2
Development

Successfully merging this pull request may close these issues.

Line2D properties should state units
5 participants
@sameshl @jklymak @timhoffm @QuLogic @dstansby