Docs panel: code snippets don't render intents
Open
Nobody has claimed this yet.
- Dominant language
- Elixir
- Stars
- 296
- Forks
- 86
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 50
Description
In dhis2, code examples don't render indents:
But indents are present in the actual source:
* @example <caption>Get with query parameters</caption>
* http.get('dataValueSets', {
* query:{
* dataSet: 'pBOMPrpg1QX',
* orgUnit: 'DiszpKrYNg8',
* period: '201401',
* fields: '*',
* }
* });
This appears to be inconsistent across functions for some reason. Each (defined in common) is absolutely fine:
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 in the Docs panel code-snippet rendering path and compare the affected dhis2 examples with the functions defined in common, where indentation renders correctly. Reproduce the inconsistent rendering using the example shown in the issue; done means source indentation is preserved consistently across code snippets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elixir
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100