Mercurial > repos > public > sbplib_julia
comparison WORKFLOW.md @ 1168:48cbcbc7a40b worklowdocs
Add a few lines about special comments
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Wed, 07 Dec 2022 22:03:22 +0100 |
parents | 6970bffad843 |
children |
comparison
equal
deleted
inserted
replaced
1166:6970bffad843 | 1168:48cbcbc7a40b |
---|---|
36 * Review code | 36 * Review code |
37 * Review tests | 37 * Review tests |
38 * Review docstrings | 38 * Review docstrings |
39 * Render Documenter and check docstrings in browser | 39 * Render Documenter and check docstrings in browser |
40 * Run full tests | 40 * Run full tests |
41 | |
42 # Special comments | |
43 The following special comments are used: | |
44 * `# TODO: `: Something that should be done at some point. | |
45 * `# TBD: `: "To be determined", i.e a decision that has to be made. | |
46 * `# REVIEW: `: A review comment. Should only exist on development branches. |