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.

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

Docs issues #17

Closed
pmli opened this issue Feb 25, 2022 · 2 comments
Closed

Docs issues #17

pmli opened this issue Feb 25, 2022 · 2 comments

Comments

@pmli
Copy link

pmli commented Feb 25, 2022 •
edited
Loading

  • The readthedocs index page doesn't seem to be synchronized with the information in the README.
  • It looks like the first docstring line is the same for:
    • pynumdiff.kalman_smooth._kalman_smooth.constant_acceleration,
    • pynumdiff.kalman_smooth._kalman_smooth.known_dynamics, and
    • pynumdiff.kalman_smooth._kalman_smooth.savgol_const_accel.
  • The documentation of _pi_cruise_control seems to be showing old_pi_cruise_control.py.

(This is related to my JOSS review: openjournals/joss-reviews#4078)
@florisvb
Copy link
Owner

florisvb commented Mar 1, 2022

I fixed issues with the documentation text itself.

I am still working on fixing the readthedocs issue, which is due to switching the github repo that the project is primarily being maintained on.

@florisvb
Copy link
Owner

florisvb commented Mar 2, 2022

The readthedocs index page is now synchronized with the README.

Closing.

@florisvb florisvb closed this as completed Mar 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@florisvb @pmli