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

Updated docstring on history module #1230

Merged
merged 4 commits into from
Dec 1, 2023
Merged

Conversation

PaulJonasJost
Copy link
Collaborator

More in Line with the Sphinx docstring

@PaulJonasJost PaulJonasJost requested a review from dweindl December 1, 2023 09:57
@codecov-commenter
Copy link

codecov-commenter commented Dec 1, 2023

Codecov Report

Attention: 398 lines in your changes are missing coverage. Please review.

Comparison is base (160c2a8) 88.16% compared to head (66d578c) 84.11%.
Report is 455 commits behind head on develop.

Files Patch % Lines
pypesto/ensemble/ensemble.py 69.36% 68 Missing ⚠️
...ypesto/hierarchical/spline_approximation/solver.py 83.68% 47 Missing ⚠️
pypesto/ensemble/util.py 65.13% 38 Missing ⚠️
pypesto/hierarchical/optimal_scaling/solver.py 93.53% 26 Missing ⚠️
pypesto/history/base.py 88.57% 24 Missing ⚠️
pypesto/hierarchical/petab.py 84.56% 23 Missing ⚠️
pypesto/engine/mpi_pool.py 0.00% 22 Missing ⚠️
pypesto/hierarchical/inner_calculator_collector.py 89.04% 16 Missing ⚠️
...pesto/hierarchical/spline_approximation/problem.py 89.18% 16 Missing ⚠️
pypesto/hierarchical/optimal_scaling/calculator.py 75.86% 14 Missing ⚠️
... and 19 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1230      +/-   ##
===========================================
- Coverage    88.16%   84.11%   -4.06%     
===========================================
  Files           79      148      +69     
  Lines         5257    11863    +6606     
===========================================
+ Hits          4635     9978    +5343     
- Misses         622     1885    +1263     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@dweindl dweindl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@@ -70,18 +70,18 @@ def update(

def finalize(
self,
message: str = None,
exitflag: str = None,
message: Union[str, None] = None,
Copy link
Member

@dweindl dweindl Dec 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For future use: this is equivalent to Optional[str]. Slightly shorter. Fine to leave as is.

pypesto/history/base.py Outdated Show resolved Hide resolved
pypesto/history/base.py Outdated Show resolved Hide resolved
pypesto/history/base.py Outdated Show resolved Hide resolved
pypesto/history/csv.py Outdated Show resolved Hide resolved
pypesto/history/csv.py Outdated Show resolved Hide resolved
pypesto/history/csv.py Outdated Show resolved Hide resolved
pypesto/history/csv.py Outdated Show resolved Hide resolved
@PaulJonasJost PaulJonasJost merged commit 00506f6 into develop Dec 1, 2023
17 checks passed
@PaulJonasJost PaulJonasJost deleted the docstring_history branch December 1, 2023 15:52
This was referenced Dec 5, 2023
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.

3 participants