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

Refresh & improve API docs #1227

Open
hrzn opened this issue Sep 19, 2022 · 0 comments
Open

Refresh & improve API docs #1227

hrzn opened this issue Sep 19, 2022 · 0 comments
Labels
documentation Creating or improving documentation improvement New feature or improvement

Comments

@hrzn
Copy link
Contributor

hrzn commented Sep 19, 2022

We should do a few things

  • Refresh and improve & clarify docs for quite a few classes and methods
  • Add information about what the models support (e.g. past or future covariates) in the docstrings of each model
  • Add more infos & examples in the "getter" methods of TimeSeries
  • Improve the format of the API docs. It would be nice to add a side-bar containing a list of all classes/methods in a file for improving the navigation.
@hrzn hrzn mentioned this issue Sep 19, 2022
Merged
@madtoinou madtoinou added improvement New feature or improvement documentation Creating or improving documentation labels Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Creating or improving documentation improvement New feature or improvement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hrzn @madtoinou