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

[ENHANCEMENT] improve documentation of settings in StressModels #574

Closed
dbrakenhoff opened this issue Mar 22, 2023 · 2 comments · Fixed by #639
Closed

[ENHANCEMENT] improve documentation of settings in StressModels #574

dbrakenhoff opened this issue Mar 22, 2023 · 2 comments · Fixed by #639
Assignees
@dbrakenhoff
Labels
documentation Indicates a need for improvements or additions to documentation enhancement Indicates improvement of existing features priority 2 low, nice to have feature to be implemented when time's available

Comments

@dbrakenhoff
Copy link
Member

The current description of settings in ps.StressModel is a bit vague for new users and refers to pastas.Timeseries for more information. I propose moving some of the pastas.Timeseries.update_series documentation to the StressModel docstring.
@dbrakenhoff dbrakenhoff added enhancement Indicates improvement of existing features documentation Indicates a need for improvements or additions to documentation labels Mar 22, 2023
@martinvonk martinvonk added the priority 2 low, nice to have feature to be implemented when time's available label May 10, 2023
@raoulcollenteur
Copy link
Member

Or duplicate it, perhaps we can construct the docstrings in a smart way by using a common strings throughout Pastas.

@dbrakenhoff dbrakenhoff mentioned this issue Sep 6, 2023
Merged
5 tasks
@dbrakenhoff dbrakenhoff linked a pull request Sep 7, 2023 that will close this issue
Improve time series settings documentation #639
Merged
5 tasks
@dbrakenhoff
Copy link
Member Author

Closed by #639.

Note: the docstring is copied a few times (that seemed simpler than programming something smart for now), so changes will have to be made in several spots if anything needs to be adjusted.

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

@dbrakenhoff dbrakenhoff

Labels
documentation Indicates a need for improvements or additions to documentation enhancement Indicates improvement of existing features priority 2 low, nice to have feature to be implemented when time's available
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve time series settings documentation pastas/pastas
3 participants
@dbrakenhoff @raoulcollenteur @martinvonk