Skip to content

Rendering @extref on Julia REPL #12

@kellertuer

Description

@kellertuer

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 @refs

  •  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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions