playfulprogramming / playfulprogramming/playfulprogramming
[Feature Request]: Dont-try-this-at-home codeblocks
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 227
- Forks
- 106
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 56
Description
Description
Codeblocks containing pseudocode, conscious errors, or other don't-try-this-at-home ideas are a great teaching tool, but might benefit from a visual indication aside from (con)textual hints. It should be clear enough so that a reader scrolling through code examples doesn't end up copying non-working code or patterns marked as 'bad'.
Describe the solution you'd like
A warning triangle in the corner or a different border would go a long way. Here be dragons! 🐉
Describe alternatives you've considered
No response
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
Locate the codeblock rendering and styling entry points, then review how pseudocode, conscious errors, or other non-working examples are currently marked. Define a visual treatment that remains clear while scrolling; done means readers can distinguish these examples before copying them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100