Request for clearer python-plugin documentation #16
Description
I am working my way through the python-plugin documentation here and here. I got pretty confused at certain points and I think I'll just keep a running log here. For now, they don't need immediate attention.
- Create a new python package (directory with a setup.py file). You can copy the setup.py file and the dripline directory structure from this repo into your own repo for this purpose, be sure to update the name and version.
This confused me until I realized that packages had a precise meaning in python. Maybe there should be some pre-requesite in the beginning of the document requesting that the reader be familiar python packages. Maybe even point to a tutorial (like this one).
Run the dripline-python container, with the repo mounted in a known path.
I was also very confused here because I didn't know what it meant by running a dripline-container. I didn't understand which repo it was talking about, or if the repo needed to be mounted in a local directory or inside the container. I asked Noah and he told me to do something like this: docker run -it -v [mounting information] driplineorg/dripline-python /bin/bash, and that makes sense to me.
I recommend giving an example command because it clears up a lot of ambiguity caused by the English language.
Typos in https://driplineorg.github.io/controls-guide/develop/guides/python-plugin.html
The are available to the provided command line applications in an integrated
The what?
It is focused on organization, desgin, and installation steps
Typos in https://github.com/driplineorg/controls-guide/tree/master/examples/dripline-python-plugin
import the classes you've imlemented and define an all list of the objects you want to add to the namespace