-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
enhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is needed
Description
I am working a bit on keyword arguments and mentioning their defaults.
I noticed that [`Example`](@ref)
is rendered nicely on REPL, while @extref
ones are not. Could this be fixed by defining a certain show Method?
Example:
If we have ManifoldsBase.jl
in the Documenter plugin like
links = InterLinks(
"ManifoldsBase" => ("https://juliamanifolds.github.io/ManifoldsBase.jl/stable/"),
)
and define somewhere in a doctoring
"""
* `X = ` [`zero_vector`](@extref `ManifoldsBase.zero_vector-Tuple{AbstractManifold, Any}`)`(M,p)` :
specify a memory internally to store the gradient
"""
function foo end
its docs on help?> foo
look like
• X = zero_vector (@extref `ManifoldsBase.zero_vector-Tuple{AbstractManifold, Any}`)(M,p): specify a memory internally to store the gradient
while I would prefer them to look like (as is done for @ref
s
• X = zero_vector (M,p): specify a memory internally to store the gradient
(zero_vector
is light blue since it is a link in REPL)
goerz and hexaeder
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is needed