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"
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 details)
Built Distribution
File details
Details for the file code_comments-0.3.1.tar.gz.
File metadata
- Download URL: code_comments-0.3.1.tar.gz
- Upload date:
- Size: 2.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.11.3 Darwin/21.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5db8180d3a71ac876cfe0b6cb7644d67cfe10ee7f5f041a1923aaa423e3f4c97 |
|
| MD5 | 2cd7ee064c75a6924045d039d3a7362a |
|
| BLAKE2b-256 | 589bb5e1731640f85d2b1e9dd1b41e9dd75baf1f52fa99997f944af4cb051697 |
File details
Details for the file code_comments-0.3.1-py3-none-any.whl.
File metadata
- Download URL: code_comments-0.3.1-py3-none-any.whl
- Upload date:
- Size: 3.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.11.3 Darwin/21.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | be920402345569b4e47b5d22140a3cf0bb2df6e6e57fa5fb57cbabddefd706cd |
|
| MD5 | 57b5c3ad757eead3588bb1a4fee4e979 |
|
| BLAKE2b-256 | f0c087ea935f3970423c7e5e214c053811708d3ddf988752164a45b699d60235 |
