Skip to content
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

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

Open
nathanaelbosch opened this issue Sep 24, 2024 · 0 comments
Open

Comments

@nathanaelbosch
Copy link
Owner

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.

@nathanaelbosch nathanaelbosch mentioned this issue Sep 24, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant