【文件属性】:
文件名称:assumptions:从代码注释生成假设和警告日志
文件大小:129KB
文件格式:ZIP
更新时间:2021-03-06 08:46:00
assumptions caveats aqa analytical-quality-assurance Python
假设
概述
在我们的分析中确认假设和警告是质量保证的重要组成部分。 当代码更改时,这应该反映在我们的文档中。
在代码注释中记录您的分析假设和警告:
# Assumption: Title of assumption
# Quality: RED
# Impact: AMBER
# Detailed description
# on one line or many.
假设将为您的文档生成Markdown假设日志:
### Assumption 1: Title of assumption
* Location: `test_git_assumptions/search_here/assumptions.py`
* **Quality** : RED
* **Impact** : AMBER
Detailed description on one line or many.
安装及使
【文件预览】:
assumptions-main
----MANIFEST.in(79B)
----README.rst(6KB)
----docs()
--------make.bat(764B)
--------LICENSE(1KB)
--------requirements.txt(54B)
--------Makefile(638B)
--------source()
----.github()
--------workflows()
----tests()
--------test_log.py(1KB)
----LICENSE(1KB)
----setup.py(2KB)
----.gitignore(70B)
----readthedocs.yml(400B)
----.bumpversion.cfg(107B)
----assumptions()
--------cli.py(2KB)
--------templates()
--------log_items.py(5KB)
--------__init__.py(144B)
--------log.py(5KB)
----.pre-commit-config.yaml(1008B)