Make examples easier to modify
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 250
- Forks
- 102
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 1
Description
Feature request from RacketCon: make it easy to copy/paste examples from scribble/examples.
The problem is that the code snippets in "Examples:" often need some context in order to run, so you can't just copy/paste from the docs to start experimenting with the examples.
One solution: add a "copy to clipboard" button to every codeblock made from an @examples[....]
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 tracing how scribble/examples renders code snippets made from @examples[....]. Check the generated documentation output and existing example-related tests, if present. Done means each such code block has a copy-to-clipboard button and the copied code includes the context needed to run it.
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