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

Improve time series settings documentation #639

Merged
merged 10 commits into from Sep 18, 2023
Merged

Conversation

dbrakenhoff
Copy link
Member

@dbrakenhoff dbrakenhoff commented Sep 6, 2023

Short Description

Improve documentation of time series settings and add type checking to settings dictionary.

Your IDE can also autocomplete the settings dictionary:

stress_settings

Checklist before PR can be merged:

- add typed dictionary definitions
- add Time Series Settings section in StressModel and TimeSeries docs
- update rcParams with new typed dicts
@codacy-production
Copy link

codacy-production bot commented Sep 6, 2023

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.03% (target: +0.00%) 100.00%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (ac3da98) 5138 3718 72.36%
Head commit (4cdd191) 5161 (+23) 3736 (+18) 72.39% (+0.03%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#639) 15 15 100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@dbrakenhoff dbrakenhoff linked an issue Sep 7, 2023 that may be closed by this pull request
pastas/utils.py Outdated Show resolved Hide resolved
@raoulcollenteur
Copy link
Member

Looks good to me, very cool! Not sure if the change in utils.py should be part of this PR already? Otherwise ready to merge I think?

Raoul

@dbrakenhoff dbrakenhoff merged commit f52d5f8 into dev Sep 18, 2023
10 checks passed
@dbrakenhoff dbrakenhoff deleted the timeseries_settings branch September 18, 2023 08:35
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 this pull request may close these issues.

[ENHANCEMENT] improve documentation of settings in StressModels
2 participants