We need to do a better job at documenting all the classes in lib/python2.7/site-packages/autobuilder/. As of now, we have: lib/python2.7/site-packages/autobuilder/buildsteps/BuildEclipsePlugin.py lib/python2.7/site-packages/autobuilder/buildsteps/PrepPkgIndex.py lib/python2.7/site-packages/autobuilder/buildsteps/BuildImages.py lib/python2.7/site-packages/autobuilder/buildsteps/PublishArtifacts.py lib/python2.7/site-packages/autobuilder/buildsteps/BuildToolchainImages.py lib/python2.7/site-packages/autobuilder/buildsteps/PublishLayerTarballs.py lib/python2.7/site-packages/autobuilder/buildsteps/CheckOutLayers.py lib/python2.7/site-packages/autobuilder/buildsteps/ResolveLayerHead.py lib/python2.7/site-packages/autobuilder/buildsteps/CreateAutoConf.py lib/python2.7/site-packages/autobuilder/buildsteps/RunBitbakeSelftest.py lib/python2.7/site-packages/autobuilder/buildsteps/CreateBBLayersConf.py lib/python2.7/site-packages/autobuilder/buildsteps/RunOeSelftest.py lib/python2.7/site-packages/autobuilder/buildsteps/CreateCurrentLink.py lib/python2.7/site-packages/autobuilder/buildsteps/RunPreamble.py lib/python2.7/site-packages/autobuilder/buildsteps/CreateIntelBSPPackage.py lib/python2.7/site-packages/autobuilder/buildsteps/RunSanityTests.py lib/python2.7/site-packages/autobuilder/buildsteps/GetDistroVersion.py lib/python2.7/site-packages/autobuilder/buildsteps/SetDest.py lib/python2.7/site-packages/autobuilder/buildsteps/GetLayerVersion.py lib/python2.7/site-packages/autobuilder/buildsteps/Sleep.py lib/python2.7/site-packages/autobuilder/buildsteps/HelloWorld.py lib/python2.7/site-packages/autobuilder/buildsteps/SyncPersistDB.py lib/python2.7/site-packages/autobuilder/buildsteps/__init__.py lib/python2.7/site-packages/autobuilder/buildsteps/TestFailStep.py lib/python2.7/site-packages/autobuilder/buildsteps/MaintainPersistDB.py lib/python2.7/site-packages/autobuilder/buildsteps/TriggerBuilds.py lib/python2.7/site-packages/autobuilder/buildsteps/NoOp.py lib/python2.7/site-packages/autobuilder/buildsteps/YoctoBlocker.py None of which appear to be documented. Documentation should follow standard python docstring standards as described in: http://legacy.python.org/dev/peps/pep-0257/ and http://legacy.python.org/dev/peps/pep-0008/
[probably should have made the comment before I reassigned] I'll work on this!
This is a tracking bug. When you decide which classes you're going to modify: 1. Open a bug for them. 2. Put this bug as depending on that. 3. Take that bug.
I am an OPW applicant. I am looking at documenting the classes in lib/python2.7/site-packages/autobuilder. Will be sending the patch soon
Any update on this, Lynn?
I had some class docs stuff sitting on a branch for a very long time while I worked on the README stuff. But the part of the README stuff that I'm on is really hard to move forward from so I'd rather swap back to this class docs stuff TLDR; no not really
*** Bug 6071 has been marked as a duplicate of this bug. ***
https://docs.google.com/document/d/1VeShmhDnqN27HXMX5emgmHFoK8Cu9SzVYilmGjtMTtI Also committed to master
Verified. Cheers, Ionut C