-
Notifications
You must be signed in to change notification settings - Fork 1
Labels
improvementInternal improvement or refactoringInternal improvement or refactoring
Description
We have had a couple cases where some HTML comments were accidentally included in the base (English) translation files. Often this is the result of accidentally putting a improperly formatted "command" like def or section inside a begin-def/end-def block, which is not allowed:
<!-- begin-def:example_1 -->
This is a sentence with __bold__ and _italic_ text.
<!-- OOPS -->
This block has two paragraphs that are captured using a `begin-def` / `end-def` pair.
<!-- end-def -->
We can make docs-builder throw an error if HTML comment syntax is detected, which should help catch cases like this earlier.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
improvementInternal improvement or refactoringInternal improvement or refactoring