TYPO3-Documentation / TYPO3-Documentation/render-guides
Warn about invalid directives
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 13
- Forks
- 19
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 60
Description
For example
-.. code-block::sql
+.. code-block:: sql
# Default charset of the database, new tables use this charset when no
# explicit charset is given with a "CREATE TABLE" statement:
references https://github.com/TYPO3-Documentation/Changelog-To-Doc/issues/951
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the directive parsing or validation entry point in the render-guides project and reproduce the malformed code-block::sql example from the issue. Determine where invalid directives are currently handled, then add coverage showing that the missing space is reported as invalid and verify the documented form remains accepted.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100