Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Numpydoc for backends #7397
Conversation
QuLogic
added the
Documentation
label
Nov 3, 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
changed the title from
[MRG] Numpydoc for backends to [MRG+1] Numpydoc for backends
Nov 21, 2016
| - * `interval`: The time between timer events in | ||
| - milliseconds. Default is 1000 ms. | ||
| + single_shot: bool |
efiring
Nov 25, 2016
Owner
Here and below, my understanding from @NelleV is that the colon must be surrounded by spaces.
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
approved these changes
Nov 25, 2016
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
|
Huh, that was way more outdated than I thought, but fortunately no conflicts. Rebased and addressed the last two comments. |
QuLogic commentedNov 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)?