Skip to content

[TASK] Comments: document that todo notes are dropped on render - #542

Open
CybotTM wants to merge 2 commits into
TYPO3-Documentation:mainfrom
CybotTM:docs/todo-not-published
Open

[TASK] Comments: document that todo notes are dropped on render#542
CybotTM wants to merge 2 commits into
TYPO3-Documentation:mainfrom
CybotTM:docs/todo-not-published

Conversation

@CybotTM

@CybotTM CybotTM commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Adds a short section that todo notes must not remain in published documentation — resolve them before merging or demote them to author-only comments.

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>
@CybotTM
CybotTM force-pushed the docs/todo-not-published branch from 1f28feb to e3a31e0 Compare August 14, 2026 13:23
@CybotTM CybotTM changed the title [DOCS] Comments: resolve todo notes before publishing [TASK] Comments: document that todo notes are dropped on render Aug 14, 2026
@CybotTM
CybotTM marked this pull request as ready for review August 14, 2026 13:30

@linawolf linawolf left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@CybotTM

CybotTM commented Aug 15, 2026

Copy link
Copy Markdown
Contributor Author

Flipped in baf5a8d, thank you — you are right that the plain-comment alternative was the wrong advice. The section now says to keep using .. todo:: for internal notes, gives your reason for preferring it over a bare .. comment (a distinct, greppable string, where .. also starts every directive and anchor), and warns only about the consequence: no visual reminder in the rendered page, so search for todo:: before merging. make test-docs renders clean.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants