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

solve_exp_ode has wrong function signature in docs #740

Closed
r0uv3n opened this issue Sep 12, 2024 · 2 comments · Fixed by #748
Closed

solve_exp_ode has wrong function signature in docs #740

r0uv3n opened this issue Sep 12, 2024 · 2 comments · Fixed by #748

Comments

@r0uv3n
Copy link
Contributor

r0uv3n commented Sep 12, 2024

In

, the doc definition disagrees with the definition in e.g.
function solve_exp_ode(
: It should be

solve_exp_ode(
        M::ConnectionManifold,
        p,
        X,
        t::Number;
        B::AbstractBasis,
        backend::AbstractDiffBackend = default_differential_backend(),
        solver = AutoVern9(Rodas5()),
        kwargs...,
    )

instead of

solve_exp_ode(
        M::ConnectionManifold,
        p,
        X,
        t::Number,
        B::AbstractBasis;
        backend::AbstractDiffBackend = default_differential_backend(),
        solver = AutoVern9(Rodas5()),
        kwargs...,
    )
@r0uv3n
Copy link
Contributor Author

r0uv3n commented Sep 12, 2024

I'll try to submit a PR to fix this and a few other issues related to solve_exp_ode sometime today.

@kellertuer
Copy link
Member

kellertuer commented Sep 12, 2024

Nice, thanks for spotting this. It seems we indeed moved the basis to a keyword argument (or designed it as positional but imlpemented it keyword).

Yes, if you could do a PR for this and other typos you find, we are always grateful for anyone helping us improving code and docs :)

edit: For the keyword of the basis in your fix, there is missing what the default is, so the line should read

    basis::AbstractBasis=DefaultOrthonormalBasis(),

and if you are stuck with a PR, we can also discuss and I can get you started on that; saw that you are from Germany, nice! We could even do that in German.

r0uv3n added a commit to r0uv3n/Manifolds.jl that referenced this issue Sep 14, 2024
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

Successfully merging a pull request may close this issue.

2 participants