Fixup the simple plugin setup docs.
Review Request #4241 — Created Sept. 16, 2016 and submitted
|patricklaw, peiyu, zundel|
src/docs/howto_plugin.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-)
Rendered here: http://pantsbuild.github.io/staging/jsirois/issues/3877/howto_plugin.html CI went green here: https://travis-ci.org/pantsbuild/pants/builds/160488897
Thanks, John. Mostly take-it-or-leave it comments below.
So, at one point I heard that plugin
__init__.pyshould be non-empty. Perhaps that is only for the internal pants plugins and has just been cargo culted everywhere.
It wouldn't surprise me to find out that it isn't required - I have never noticed an adverse effect when it wasn't included.
The details do not match the instructions here ("up to but not including the root directory") since there is no
I think I would remove the "When registering a backend in pants.ini" part of this paragraph. The pants.ini is discussed more in the next section.
It might be worth mentioning that
pythonpath + the plugin's backend_packages entryshould represent the path to the register.py. If you can think of a simple way to explain that.
I used to get confusing registration errors until I finally understood that relationship.
Status: Closed (submitted)
Now on master: git log -1 origin/master commit 392c92c985cbc4c1eac8ef8da736c61b7ce4e89f Author: John Sirois <firstname.lastname@example.org> Date: Sun Sep 18 15:09:02 2016 -0600 Fixup the simple plugin setup docs. Testing Done: Rendered here: http://pantsbuild.github.io/staging/jsirois/issues/3877/howto_plugin.html CI went green here: https://travis-ci.org/pantsbuild/pants/builds/160488897 Bugs closed: 3877, 3878 Reviewed at https://rbcommons.com/s/twitter/r/4241/