Examples that use `.` for improper lists render incorrectly
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 250
- Forks
- 102
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 1
Description
The examples at
https://github.com/racket/racket/blob/master/pkgs/racket-doc/scribblings/reference/hashes.scrbl#L596
make hash tables like: (make-immutable-hash '([1 . (one uno)] [2 . (two dos)]))
however the documentation renders this as:
(make-immutable-hash '([1 one uno] [2 two dos]))
(with the extra spaces between the keys and the values).
Unfortunately this makes those docs a little confusing to read... I'm guessing this happens because read-syntax doesn't preserve the ., but I'm not sure how to go about fixing, since there doesn't seem to be a syntax property that says "dot goes here".
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 examples around pkgs/racket-doc/scribblings/reference/hashes.scrbl#L596 and inspect how read-syntax handles the dotted pairs shown there. The work is done when those examples render with the dots preserved and the displayed code matches the source syntax.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100