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

Skip to content

MEP10 - refactored hlines and vlines documentation #1795

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 4 commits into from
Mar 14, 2013
Merged

MEP10 - refactored hlines and vlines documentation #1795

merged 4 commits into from
Mar 14, 2013

Conversation

NelleV
Copy link
Member

@NelleV NelleV commented Feb 28, 2013

Refactored hlines and vlines documentation to match MEP10

Thanks,
N


%(LineCollection)s
Copy link
Member

Choose a reason for hiding this comment

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

Have the contents of this now been included directly?

Copy link
Member Author

Choose a reason for hiding this comment

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

Nope, this is lost. Using this trick doesn't work (it is not rendered properly), and numpydoc has no way to do introspection to spot that these are linecollection kwargs.

Copy link
Member

Choose a reason for hiding this comment

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

I know that whether to continue to include these inline was controversial -- but I tend to fall on the side of not duplicating this information everywhere. If we do that, though, we need a clear link to the LineProperties class, and my suggested change for the Returns section above does that.

kwargs are :class:`~matplotlib.collections.LineCollection` properties:
Returns
-------
matplotlib.collections.LineCollection
Copy link
Member

Choose a reason for hiding this comment

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

This has to be of the form name : type or it doesn't render correctly, i.e.

lines : matplotlib.collections.LineCollection

@mdboom
Copy link
Member

mdboom commented Feb 28, 2013

This looks good -- this is the first time I've spent the time to actually build and look at the output of your MEP10 changes. It looks great -- but sorry if I'm commenting on issues that may have already gone a different way in earlier PRs (such as how the Returns section is written etc.)

@NelleV
Copy link
Member Author

NelleV commented Feb 28, 2013

For the curious, I just set up an automatic build of the documentation of the master branch of the repository here:
http://cbio.ensmp.fr/~nvaroquaux/matplotlib/doc/ and a check of the flake8 report here (but links don't work):
http://cbio.ensmp.fr/~nvaroquaux/matplotlib/flake8_report/

The flake8 report could be done by shining panda, or something more adapted than bash scripts.

@mdboom
Copy link
Member

mdboom commented Feb 28, 2013

Thanks. Once we get funding in place, I hope to set up a Shining Panda pro account for matplotlib soon -- and this is definitely the kind of useful thing to do over there.

@mdboom
Copy link
Member

mdboom commented Feb 28, 2013

Great. I think it's good (as we doing here) to get the first few docstrings really right and then running through the rest should involve a lot of just following the same pattern.

@NelleV
Copy link
Member Author

NelleV commented Mar 7, 2013

I think this is ready to be merged.

@mdboom
Copy link
Member

mdboom commented Mar 7, 2013

I'm seeing funky formatting when building this. It looks like "Other Parameters" is divided into two sections...?
funky-formatting

@NelleV
Copy link
Member Author

NelleV commented Mar 7, 2013

Other parameters can have a list of parameter as the "parameters" section has, so I think this is normal.

@mdboom
Copy link
Member

mdboom commented Mar 7, 2013

But why is it on a different background color, with a line above it (unlike Parameters above)? It looks like it's in a different section (at least to my eyes).

@NelleV
Copy link
Member Author

NelleV commented Mar 14, 2013

It is either the way it is supposed to be or a bug in numpydoc. After digging in numpy and scipy's code, I finnaly found a place where this was used:http://docs.scipy.org/doc/scipy/reference/generated/scipy.weave.inline.html#scipy.weave.inline

There's nothing much we can do about that, except submit a patch to numpydoc.

@mdboom
Copy link
Member

mdboom commented Mar 14, 2013

Ok thanks for looking into it. Since it's not anything we can fix from our end, I'll go ahead and merge this. Thanks.

mdboom added a commit that referenced this pull request Mar 14, 2013
MEP10 - refactored hlines and vlines documentation
@mdboom mdboom merged commit 9690232 into matplotlib:master Mar 14, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants