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.

Sign up for GitHub

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

Jump to bottom

Overloads of deprecated functions causing bad formatting #57

Open

DominicDirkx opened this issue Jan 23, 2023 · 0 comments

Member

DominicDirkx commented Jan 23, 2023

Due to the use of deprecated overloads for factory functions of integrator/propagator such as:
https://py.api.tudat.space/en/latest/integrator.html#tudatpy.numerical_simulation.propagation_setup.integrator.runge_kutta_fixed_step_size
the formatting of the associated docs issue is messed up.

A partial fix was posted here:
https://tudat.slack.com/archives/C01NSEK6CLC/p1668073019477829?thread_ts=1666011882.265549&cid=C01NSEK6CLC
resulting in docstrings formatted as:

Ideally, the deprecated function should not show up in the API docs at all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment