Heat 自定义指南¶
https://blueprints.launchpad.net/heat/+spec/custom-guidelines
需要添加自定义指南,以方便审查新的资源并改进描述编写。
问题描述¶
目前,关于如何编写资源、属性、特性和方法的描述,存在一些规则。为了方便审查并改进描述编写,需要添加 Heat 自定义指南,并在 tox pep8 运行期间启动它。
提议的变更¶
目前,描述编写有一些明显的规则
资源、属性、特性和方法的描述结尾处使用句号。
描述中不允许出现双空格或更多空格。
资源应该包含关于其用途的描述,除了摘要之外。
行首不允许有空格 - 如果描述字符串很长并分成几行,空格应该位于行尾而不是下一行开头。
建议的解决方案是编写自定义 Heat 指南来涵盖这些规则,并将其添加到 tox pep8 检查中。
备选方案¶
无。
实现¶
负责人¶
- 主要负责人
prazumovsky
里程碑¶
- 完成目标里程碑
mitaka-3
工作项¶
添加当前 Heat 描述的自定义指南规则。
解决使用新的检查发现的所有问题。
将自定义指南检查添加到 pep 中。
依赖项¶
无。