Scribble page info returns incorrect source file
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 250
- Forks
- 102
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 1
Description
What program did you run?
https://docs.racket-lang.org/drracket/Keyboard_Shortcuts.html
3.3 Keyboard Shortcuts
Link to this section with
@secref["Keyboard Shortcuts"
#:doc '(lib "scribblings/drracket/drracket.scrbl")]
Document source
https://github.com/racket/drracket/tree/master/drracket/scribblings/drracket/drracket.scrbl
What should have happened?
Follow @include-section from
https://github.com/racket/drracket/blob/master/drracket/scribblings/drracket/drracket.scrbl
via https://github.com/racket/drracket/blob/master/drracket/scribblings/drracket/interface-ref.scrbl
to return https://github.com/racket/drracket/blob/master/drracket/scribblings/drracket/keybindings.scrbl
**alternative **
eliminate @include-section from manuals,
consider removing @include-section from scribble/manual
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 by tracing the page-info behavior for the Keyboard Shortcuts section in drracket/scribblings/drracket/drracket.scrbl. Follow its @include-section through interface-ref.scrbl to keybindings.scrbl and compare the reported source file with the expected file. Review the alternative proposal to remove @include-section from manuals or scribble/manual before defining what the fix should cover.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100