radius-project / radius-project/docs
Suggestion: find a better way to indicate a partial code snippet
Open
Nobody has claimed this yet.
bug
triaged
- Dominant language
- Bicep
- Stars
- 26
- Forks
- 52
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 3
Description
Describe the bug
When we have a code snippet that's partial (showing changes to only part of a large file) we usually terminate the code snippet with ... or just omit the other parts of the file.
The suggestion is that we could find a way to show the rest of the code (collapsed by default) or to fade or pixelate the text of the sample that aren't the focus.
Contributor guide
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
No files, tests, or entry points are identified in the issue. Start by locating how documentation code snippets are rendered, then define and test a collapsed, faded, or pixelated treatment for omitted code that clearly indicates the partial context.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100