HomeClusterLabs Projects

Refactor: python: Modify docstrings to follow PEP 257.

Description

Refactor: python: Modify docstrings to follow PEP 257.

  • The first line of each docstring should end with a period.
  • Remove spaces between the docstring and its enclosing triple quotes.
  • Remove empty lines between the docstring and the code that comes after it.
  • Remove empty lines between "Arguments:" and the list of arguments.
  • Multi-line docstrings should start on the line after the triple quotes and all lines should be indented the same amount.
  • Add docstrings for methods that were missing one.

Details

Provenance
clumensAuthored on Jan 3 2024, 4:48 PM
Parents
rP44a0902018f2: Merge pull request #3304 from kgaillot/T137
Branches
Unknown
Tags
Unknown