JuliaDocs/Documenter.jl

cross-references to docstrings with context

Open

#1,670 opened on 2021年8月10日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (平均マージ 16d 9h) (30d で 3 merged PRs)

説明

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?

コントリビューターガイド