The docstring provides a way to describe test details and we are publishing factor pytest docs in https://storage.googleapis.com/chromeos-factory-docs/sdk/pytests/index.html .
Currently most tests do not have "good" docs. I think we want to create a template so that each test has following information that when a partner or non-factory engineer asks "what does this test do?", we can have a good page of description:
SUMMARY (One line as summary of this test)
DESCRIPTION
Short description for what this test is and the scope of test.
TEST PROCEDURE
Mostly for interactive tests - what OP should do.
DEPENDENCY
List what python modules or userland tools are needed
EXAMPLE
Example of how to use this test (in test list).
NOTES
Additional notes (if any)
Comment 1 by hungte@chromium.org
, Jun 29 2017