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.2.tar.gz
(3.0 kB
view details)
Built Distribution
File details
Details for the file code_comments-0.3.2.tar.gz.
File metadata
- Download URL: code_comments-0.3.2.tar.gz
- Upload date:
- Size: 3.0 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 | 7c93ebb84a1271189cc7ce7e340e3d5da8dc545d66d73fc0da80848167ab82ad |
|
| MD5 | 0456fb6ee29bd1ceabe1b251fc4d894f |
|
| BLAKE2b-256 | f2e66b6241e2c4fae9b71f657e8f6b68fcd4298203643f15ddd4272a63ae5fad |
Provenance
File details
Details for the file code_comments-0.3.2-py3-none-any.whl.
File metadata
- Download URL: code_comments-0.3.2-py3-none-any.whl
- Upload date:
- Size: 3.9 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 | e250a067dc26c08bce24983841a6cb6c030bef355ca32716855640a8127529ff |
|
| MD5 | 6d6eaaa54dbfcd9882f8e41cc15d7193 |
|
| BLAKE2b-256 | 7d15e854e91df7aaaaf0478d8b48851d443a231e987caaea8ab31f7f578aca82 |
