openbmc / openbmc-test-automation

Apache License 2.0
100 stars 92 forks source link

Python function Docstrings write up guidelines #2202

Closed susilsi7 closed 11 months ago

susilsi7 commented 1 year ago

Which will have high precedence.

  1. Function Documentation
  2. Description of argument
  3. Example of function
  4. Argument example
gkeishin commented 11 months ago

This is something we don't mandate apart from known community Python doc string. There are examples already in the code in openbmc test Please follow it and if extra input feedback is required, we will see it on use case basis. since we don't plan to revamp all our documentation.