Need to add custom guidelines to facilitate reviewing new resources and improve descriptions writing.
Currently there are several rules on how to write descriptions of resources, properties, attributes and methods. For facilitate reviewing and improve description writing, need to add heat custom guidelines and start it during tox pep8 running.
Currently there are several obvious rules of description writing:
- Terminator at the end of resources, properties, attributes and methods descriptions.
- No double or more whitespaces in descriptions.
- Resource should contain description about it’s purpose in addition to summary.
- No leading whitespaces in the lines - if description string is long and split into a few lines, whitespaces should be at the end of lines and not at the begin of next lines.
Proposed solution is to write custom heat guidelines to cover these rules and to add it to tox pep8 check.