prometheus / prometheus/OpenMetrics
Code blocks are poorly formatted in OpenMetrics.txt
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2.5k
- Forks
- 175
- PR merge metrics
- No merged PRs in 30d
Description
For instance:
Other code blocks are similarly messed up (search for ~~~~).
It seems the Markdown to RFC converter does not support tilde-delimited code blocks.
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
Inspect specification/OpenMetrics.txt around lines 802-820 and search the document for ~~~~ to catalog the affected code blocks. Then locate the Markdown-to-RFC conversion entry point and check how tilde-delimited blocks are handled. Done means those blocks render as code in the generated RFC output without breaking other formatting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100