Docs say inset-flow accepts pre-flow?, but its contract uses pre-content?
Open
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 250
- Forks
- 102
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 1
Description
scribble-lib/scribble/private/manual-style.rkt contains the following lines:
(provide/contract
…
[inset-flow (() () #:rest (listof pre-content?) . ->* . nested-flow?)]
…)
but the documentation uses this signature:
(inset-flow pre-flow ...) → nested-flow?
pre-flow : pre-flow?
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 with the contract in scribble-lib/scribble/private/manual-style.rkt and compare it with the documented inset-flow signature shown in the issue. Determine which predicate is intended, then align the documentation or contract and verify that the resulting signatures agree.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100