Tutorial 'continue.scrbl' signatures rendering confusing to readers
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 99
- Forks
- 48
- PR merge metrics
- No merged PRs in 30d
Description
The rendering of signatures in the Continue tutorial is confusing to readers
In the tutorial, functions are often described, then followed by their signature in the familiar scribble/manual format.
Unfortunately the hairline at the top of the signature, in addition to the large gap above, and lack of a gap below gives the impression the signature is associated with the subsequent text.
My suggestion is the rendering of continue is changed to support the 'description followed by signature' style of the text. I'd suggest moving the hairline to the bottom of the signature, and increasing the spacing between the signature and the subsequent paragraph.
Options to resolve;
- a different css stylesheet for continue.scribble
- an new signature function that handles spacing differently
- other options?
https://github.com/racket/scribble/blob/master/scribble-lib/scribble/private/manual-proc.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
Start with web-server-doc/web-server/scribblings/tutorial/continue.scrbl and inspect the signature rendering used there, then read scribble-lib/scribble/private/manual-proc.rkt to understand the relevant manual formatting. Compare the tutorial's description/signature spacing with the linked example; done means the signature is visually associated with the preceding description and separated from the following paragraph.
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