JuliaDocs/Documenter.jl

cross-references to docstrings with context

Open

#1670 aperta il 10 ago 2021

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Julia (513 fork)batch import
Type: Enhancementhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

I can cross-reference to the docstring of the function fun via [`fun`](@ref). In a sentence, the reference may occur as [`fun`](@ref)(`x`). Today I have learned (from @rfourquet) that also [`fun(x)`](@ref) works, which is simpler. However, the hyperlink created by this variant extends over fun(x), whereas the reference is (logically) intended to point to fun. Since Documenter apparently finds out from the string fun(x) that fun is the target in question, wouldn't it make sense to restrict the hyperlink automatically to this substring?

Guida contributor