-
Notifications
You must be signed in to change notification settings - Fork 481
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow named @ref to docstrings without backticks #781
Comments
Bump! Oh, how I would love to be able to do this. There are many times I really want to use better prose but attach a cross-link to a docstring. Is there really no |
working around JuliaDocs/Documenter.jl#781
What works is The only issue I see is how would one distinguish the custom heading IDs from function references. But we could prioritize one over the other I guess -- first see if there is a header ID like that and, if not, look for a docstring. So the algorithm could be
Could be a good hacktoberfest issue 😉 |
* Better documentation and docs search for punctuation * Update doc/src/base/punctuation.md Co-Authored-By: James Bradbury <[email protected]> * Update doc/src/base/punctuation.md Co-Authored-By: James Bradbury <[email protected]> * Fixup crosslinks working around JuliaDocs/Documenter.jl#781
Bump. I just had exactly this issue. |
You might sometimes want to link to a function without explicitly writing the function name. Currently, writing
[some function](@ref somefunction)
for a function namedsomefunction
does not work.The text was updated successfully, but these errors were encountered: