Corrected kaplan_meier_estimator documentation to give correct default argument #430
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
value Problem: kaplan_meier_estimator docstring shows conf_type default argument as log-log instead of None Solution: Changed docstring to match code
|
Thanks for your PR. Could you please also fix the documentation of |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #430 +/- ##
=======================================
Coverage 98.04% 98.04%
=======================================
Files 37 37
Lines 3423 3423
Branches 516 516
=======================================
Hits 3356 3356
Misses 32 32
Partials 35 35 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem: kaplan_meier_estimator docstring shows conf_type default argument as log-log instead of None
Solution: Changed docstring to match code
Checklist
What does this implement/fix? Explain your changes
Was wondering why my code wasn't working, turns out the wrong default argument is listed on the docs. This should fix it. Haven't checked for disparity between docs and code for other functions/classes but this is the only one I've had issues with so far.