Skip to content

Citations in docstrings are not visualized properly in the REPL #329

@nathanaelbosch

Description

@nathanaelbosch

Some citation references in the docstrings do not seem to work properly, e.g.,

help?> EK1
search: EK1 DiagonalEK1

EK1(; order=3,
        smooth=true,
        prior=IWP(order),
        diffusionmodel=DynamicDiffusion(),
        initialization=TaylorModeInit(num_derivatives(prior)),
        kwargs...)

Gaussian ODE filter with first-order vector field linearization.

This is a semi-implicit, L-stable ODE solver so it can handle stiffness quite well
tronarp18probsol (@cite), and it generally produces more expressive posterior covariances than the
EK0. However, as typical implicit ODE solvers it scales cubically with the ODE dimension
krämer21highdim (@cite), so if you're solving a high-dimensional non-stiff problem you might want
to give the EK0 a try.

Ideally, instead of tronarp18probsol (@cite) the user should see some relevant information about the citation.

There is currently an open issue JuliaDocs/DocumenterCitations.jl#21 that relates to this question, and resolving that issue should also result in more readable REPL documentation in this package. But at the time of writing, DocumenterCitations.jl does not provide this functionality.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions