JuliaDocs/Documenter.jl

cross-references to docstrings with context

Open

#1,670 建立於 2021年8月10日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Julia (513 fork)batch import
Type: Enhancementhelp wanted

倉庫指標

Star
 (910 star)
PR 合併指標
 (平均合併 16天 9小時) (30 天內合併 3 個 PR)

描述

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?

貢獻者指南