Skip to content

More docstring cleanup of Line2D. #11938

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
Aug 26, 2018
Merged

Conversation

timhoffm
Copy link
Member

PR Summary

This is a continuation of #11922.

  • Getters reference the corresponding setters as they usually contain more information on the property.
  • Converted a few other docstrings to numpydoc format.

@timhoffm timhoffm added this to the v3.1 milestone Aug 26, 2018
``{'ind': pointlist}``
Where *pointlist* is the set of points within the radius.

TODO: sort returned indices by distance
Copy link
Contributor

Choose a reason for hiding this comment

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

leave this out of the docstring? :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Well, it's been in there before. I didn't bother to decide if this should stay or be moved to a comment or be deleted completely.

Just checked: It's a comment by John D. Hunter from 2007. Anyone thinks this is still relevant?

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's just leave it in for now, didn't notice it was already there.

@@ -729,7 +748,15 @@ def _is_sorted(self, x):

@allow_rasterization
def draw(self, renderer):
"""Draw the Line with *renderer* unless visibility is *False*."""
"""
Copy link
Contributor

Choose a reason for hiding this comment

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

Would suggest just deleting this docstring and moving it (after adapting it) to Artist.draw, subclasses will then inherit it (more accurately, inspect.getdoc (which e.g. pydoc and ipython's foo? use) will lookup the docstring in the super methods).

@NelleV NelleV merged commit b47fd63 into matplotlib:master Aug 26, 2018
@NelleV
Copy link
Member

NelleV commented Aug 26, 2018

Thanks @timhoffm

@timhoffm timhoffm deleted the doc-line2d-part2 branch August 26, 2018 16:30
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