Tool to report on comments such as TODO
Project description
code-comments
This project was created as a way of creating a central "annotation" file of all the useful
notes that might be created in a code base such as todo
or 'tfsec' comments.
Configuration
The project can be configured via a TOML file which by default is called .code-annotations.toml
but can be override with the --config
flag.
Below is an example which can be found at .code-annotations.toml
file_suffix=[".tf"]
output_file="ANNOTATIONS.md"
comment_syntax = ["#"]
[[headers]]
comment = "tfsec"
table_headers = "File:Line|Type|Comment"
[[headers]]
comment = "todo"
table_headers = "File:Line|Date|Comment"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
code_comments-0.3.1.tar.gz
(2.9 kB
view hashes)
Built Distribution
Close
Hashes for code_comments-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be920402345569b4e47b5d22140a3cf0bb2df6e6e57fa5fb57cbabddefd706cd |
|
MD5 | 57b5c3ad757eead3588bb1a4fee4e979 |
|
BLAKE2b-256 | f0c087ea935f3970423c7e5e214c053811708d3ddf988752164a45b699d60235 |