Incorrect docs on `part-start` (and probably related functions)
Open
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 250
- Forks
- 102
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 1
Description
The documented contract is
(struct part-start (depth tag-prefix tags style title)
#:extra-constructor-name make-part-start)
depth : integer?
tag-prefix : (or/c #f string?)
tags : (listof string?)
style : style?
title : content?
while the actual contract on the constructor is:
(->
integer?
(or/c #f string?)
(listof tag?)
style?
content?
part-start?)
Note contracts on tags.
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
Search the documentation for part-start and its related functions, then compare the documented constructor contract with the actual contract shown in the issue. Correct the tags contract and any corresponding discrepancies, and confirm that the published documentation matches the constructors.
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
- Mostly clear
- Newbie friendliness
- 48/100