[TASK] Comments: document that todo notes are dropped on render - #542
[TASK] Comments: document that todo notes are dropped on render#542CybotTM wants to merge 2 commits into
Conversation
The renderer silently drops .. todo:: directives - their content never reaches the rendered page. Document that behaviour: resolve open tasks before merging, or write them as plain comments so they stay clearly author-only. Assisted-by: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
1f28feb to
e3a31e0
Compare
linawolf
left a comment
There was a problem hiding this comment.
I'd drop the "or write them as plain comments" alternative. I implemented
.. todo:: myself — not rendering it is by design, not a quirk. It's meant
to be an internal todo comment, and a better one than a bare .. comment,
since todo:: is a distinct, greppable string (.. alone also starts every
directive and anchor).
I'd flip the guidance: keep using .. todo:: for internal notes, just warn
that it gives no visual reminder in the rendered output — grep for todo::
before merging rather than relying on noticing it in a preview.
Reviewer feedback: not rendering .. todo:: is by design, not a quirk, and it is the better internal marker than a bare .. comment because todo:: is a distinct, greppable string while .. also starts every directive and anchor. Flip the guidance accordingly: keep using .. todo:: for internal notes, drop the plain-comment alternative, and warn that the reminder only works if somebody searches for it before merging. Assisted-by: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
|
Flipped in baf5a8d, thank you — you are right that the plain-comment alternative was the wrong advice. The section now says to keep using |
Adds a short section that todo notes must not remain in published documentation — resolve them before merging or demote them to author-only comments.