Skip to content

DOC changed documentation for axvspan to numpydoc format @NelleV #7039

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

Closed
wants to merge 1 commit into from

Conversation

Wiolcia
Copy link
Contributor

@Wiolcia Wiolcia commented Sep 5, 2016

Updated documentation of axvspan function to numpydoc format, as part of a project during the ASPP2016 Summer School


%(Polygon)s
Copy link
Member

Choose a reason for hiding this comment

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

Why remove this?

Copy link
Member

Choose a reason for hiding this comment

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

Agree with @QuLogic this should probably stay

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 should be removed and moved to a place with clean and readable summaries. These make the documentation unreadable in an Ipython terminal. They also make the documentation much harder to maintain and modify. They are also not standard, and thus makes contributing to the documentation much harder.

Copy link
Member

Choose a reason for hiding this comment

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

If these sorts of tables are going to be removed, it should be done in a coordinated way ( @efiring is also on board with this) not piecemeal.

@QuLogic
Copy link
Member

QuLogic commented Sep 6, 2016

This PR should probably be coordinated with #7037 to get consistent prose.

@NelleV
Copy link
Member

NelleV commented Sep 6, 2016

Apart from my comments, this look great!

Thanks,
N

@tacaswell tacaswell added this to the 2.0.1 (next bug fix release) milestone Sep 24, 2016
@NelleV
Copy link
Member

NelleV commented Oct 13, 2016

I am closing this PR: I've created a new one with the additional changes needed to merge this in.
Thanks for the contribution!

@NelleV NelleV closed this Oct 13, 2016
@QuLogic QuLogic modified the milestones: 2.0.1 (next bug fix release), unassigned Dec 7, 2016
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.

5 participants