add the ability to link from the docs to the defining file in the source,
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 250
- Forks
- 102
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 1
Description
it was commented recently that linking to source definitions from the documentation to the defining file in GitHub(lab/etc) would be useful. (note finding the definition of an identifier from DrR or RaMo is already available)
a) defproc code will know the defining file, and the code for the section should know the package that the module is in
alternative: use identifier-binding to get the file (‘Linking to the source file is relatively easy, since that information is in the binding’)
NB see code in https://github.com/racket/scribble/pull/229/files
(harder) to add the ability to link from the docs to the DEFINITION in the defining file in the source,
b) find the line/col with drracket/check-syntax or use find-def-in-file
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 scribble/private/manual-proc.rkt and review the code in pull request 229, especially how defproc identifies definitions and their packages. Compare the identifier-binding alternative with drracket/check-syntax and find-def-in-file. Done should include links from generated documentation to the defining source file and, if the harder scope is included, to the definition itself.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100