Update to scribble/example in section "4.1.5 Showing Racket Examples"
Open
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 250
- Forks
- 102
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 1
Description
This section still uses interaction-eval from scribble/eval instead of the newer examples with #:hidden from scribble/examples.
I think these are the necessary changes, instead of:
@(require scribble/eval ...)
@interaction-eval[#:eval helper-eval
(require "helper.rkt")]
It should be:
@(require scribble/example ...)
@examples[#:hidden #:eval helper-eval
(require "helper.rkt")]
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
Locate section "4.1.5 Showing Racket Examples" and review its current scribble/eval example. Update the documented require and example form to the newer scribble/examples approach shown in the issue, then verify the rendered section uses the hidden example correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100