Numpydoc for backends #7397
Numpydoc for backends #7397
Conversation
|
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. |
|
|
||
| * `interval`: The time between timer events in | ||
| milliseconds. Default is 1000 ms. | ||
| single_shot: bool |
There was a problem hiding this comment.
Here and below, my understanding from @NelleV is that the colon must be surrounded by spaces.
There was a problem hiding this comment.
Grrr, thought I got all of those.
There was a problem hiding this comment.
Yep, else it won't render properly. I wouldn't hold this PR for this thought. It's been around way too long.
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.
e3c61c1 to
cff8615
Compare
|
Huh, that was way more outdated than I thought, but fortunately no conflicts. Rebased and addressed the last two comments. |
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)?