racket / scribble

Other
197 stars 91 forks source link

add the ability to link from the docs to the defining file in the source, #238

Open spdegabrielle opened 4 years ago

spdegabrielle commented 4 years ago

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

slack thread

countvajhula commented 3 years ago

This would be wonderful.