Add Plugin base classes APIs to readthedocs #2736
Conversation
|
Voight Kampff Integration Test Succeeded (Results) |
e7a08a9 to
3a0e039
Compare
|
I've updated with the suggested texts (in all cases except one) I tried to reword the index page. but might need some more tlc. |
|
Voight Kampff Integration Test Failed (Results) |
|
Voight Kampff Integration Test Succeeded (Results) |
|
Is there a commit missing here, I'm seeing a few unchanged. Also small nitpick - we don't seem to be consistent with the argument type being before or after the colon, eg:
|
|
I'll look over the argument type changes. Likely I've gotten confused over time and mix up the order. Can you give an example of unchanged? |
3a0e039 to
e552910
Compare
|
Now I see what you mean. I seem to have missed most of your comments. sorry about that |
|
Voight Kampff Integration Test Succeeded (Results) |
|
I think this is once more ready for review. All of the comments should be handled now...I think |
Description
This updates the docstrings for the base classes for the pluggable systems to provide more of the information needed for creating plugins. Plugins are also added to the API documentation.
I'd very much appreciate improvementson the docstrings I've suggested here.
How to test
run
make htmlin thedocsfolder and check that the resulting plugin documentation looks good.Contributor license agreement signed?
CLA [ Yes ]