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

Skip to content

Fix numpydoc parameter formatting #12435

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
Oct 8, 2018

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Oct 7, 2018

PR Summary

This PR aligns the docs with the numpydoc requirements for Paramters:

The colon must be preceded by a space, or omitted if the type is absent.

@timhoffm timhoffm force-pushed the fix-numpydoc-parmeters-format branch from e65feed to e1e904e Compare October 7, 2018 18:40
@timhoffm timhoffm added this to the v3.1 milestone Oct 7, 2018
@@ -562,7 +562,7 @@ def anchored(self, c, container=None):

Parameters
----------
c :
c : tuple or str
Copy link
Contributor

Choose a reason for hiding this comment

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

tuple -> (float, float)

@@ -106,9 +106,9 @@ def __init__(self, *args, pad=0, add_all=True, **kwargs):
defaults to True.
axes_class : matplotlib.axes.Axes

kl :
kl
Copy link
Contributor

Choose a reason for hiding this comment

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

what's kl here?

Copy link
Member Author

@timhoffm timhoffm Oct 7, 2018

Choose a reason for hiding this comment

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

That *args now. Has been renamed in the signature recently without updating the docstring (a68784f).

Now renamed in docstring as well.

@timhoffm timhoffm force-pushed the fix-numpydoc-parmeters-format branch from e1e904e to 802c3f4 Compare October 7, 2018 20:09
@dstansby dstansby merged commit 8ca36cb into matplotlib:master Oct 8, 2018
@timhoffm timhoffm deleted the fix-numpydoc-parmeters-format branch October 8, 2018 15:50
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