Numpydoc for backends #7397

Merged
merged 4 commits into from Nov 26, 2016

Conversation

Projects
3 participants
Member

QuLogic commented Nov 3, 2016

I've had this lying around for a while, but it's incomplete insofar as I didn't have a chance to add types to everything. I don't really want it to go completely to waste though.

Apparently, I had a lot of free time at the beginning of the year and did the same for a lot of other files. The trouble is, that was with the expectation of switching to napoleon, so there are a few corrections that need to be made to work with our current build (which you can see in the second commit here.) Should I post those up somewhere (and maybe tag with Need contributor)?

Member

QuLogic commented Nov 14, 2016

I've added types to all the backend files I've already touched. The descriptions are not perfect, but several of the backends do not appear in the documentation, presumably because they cannot all be loaded at the same time or the dependencies are not available. I tried adding them, but it broke the builds, so that's something for another time.

QuLogic changed the title from Numpydoc for backends to [MRG] Numpydoc for backends Nov 14, 2016

@NelleV

NelleV approved these changes Nov 21, 2016

NelleV changed the title from [MRG] Numpydoc for backends to [MRG+1] Numpydoc for backends Nov 21, 2016

lib/matplotlib/backend_bases.py
- * `interval`: The time between timer events in
- milliseconds. Default is 1000 ms.
+ single_shot: bool
@efiring

efiring Nov 25, 2016

Owner

Here and below, my understanding from @NelleV is that the colon must be surrounded by spaces.

@QuLogic

QuLogic Nov 25, 2016

Member

Grrr, thought I got all of those.

@NelleV

NelleV Nov 25, 2016

Contributor

Yep, else it won't render properly. I wouldn't hold this PR for this thought. It's been around way too long.

@efiring

Looks fine based on a quick scan, apart from the two spots where spaces probably need to be inserted.

QuLogic added some commits Jan 6, 2016

@QuLogic QuLogic DOC: Add correct headings for backend files. 8944735
@QuLogic QuLogic DOC: Make backends compatible with numpydoc.
The previous changes were intended for napoleon, but that has yet to be
merged. NumPyDoc supports a few less section names, and requires them to
be in a specific order. Also, a little bit of whitespace change needed
to render stuff properly.
b4afdb6
@QuLogic QuLogic doc: Add types to backend listings. 487a508
@QuLogic QuLogic doc: Add backend_mixed to build.
cff8615
Member

QuLogic commented Nov 26, 2016

Huh, that was way more outdated than I thought, but fortunately no conflicts. Rebased and addressed the last two comments.

efiring changed the title from [MRG+1] Numpydoc for backends to Numpydoc for backends Nov 26, 2016

@efiring efiring merged commit 6a56f69 into matplotlib:master Nov 26, 2016

2 of 3 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 62.003%
Details

QuLogic deleted the QuLogic:doc-backends branch Nov 26, 2016

QuLogic added this to the 2.1 (next point release) milestone Nov 26, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment