Skip to content
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

DOC : add documentation to Polygon methods #3123

Merged
merged 1 commit into from
Jun 7, 2014

Conversation

tacaswell
Copy link
Member

closes #3035

@tacaswell tacaswell added this to the v1.4.0 milestone Jun 7, 2014

Returns
-------
path : Path
Copy link
Member

Choose a reason for hiding this comment

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

You should probably cross-ref the Path class.

Copy link
Member Author

Choose a reason for hiding this comment

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

What is the easiest way to do that? I was hoping sphinx would auto-magically do that for this...

Copy link
Member

Choose a reason for hiding this comment

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

I think it would be:

:class:`Path`

or whatever the resolvable name would be at that point in the code.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated and forced.

efiring added a commit that referenced this pull request Jun 7, 2014
DOC : add documentation to Polygon methods
@efiring efiring merged commit 2a0fb2b into matplotlib:master Jun 7, 2014
@tacaswell tacaswell deleted the polygon_doc branch June 7, 2014 23:05
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.

Add docs to Polygon *_xy
4 participants