-
Notifications
You must be signed in to change notification settings - Fork 2
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
slight refactorings, docs, typos #298
Conversation
…ndary_trend into single function
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## csg_filling #298 +/- ##
===============================================
- Coverage 96.94% 96.93% -0.01%
===============================================
Files 54 54
Lines 5205 5194 -11
===============================================
- Hits 5046 5035 -11
Misses 159 159 ☔ View full report in Codecov by Sentry. |
Thanks for adding docs. I should have said that I intentionally left them for after your review so I don't have to rewrite them in case of changes. Sorry, didn't intend to make you write the docs. |
@@ -12,23 +14,16 @@ class Gap: | |||
|
|||
Attributes | |||
---------- | |||
type : | |||
type |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems that my pycharm setting for docstrings is not correct, that added the colons, I think
@@ -71,15 +68,6 @@ class FitParameters: | |||
minimal number of points to calculate the trend. Default is 1, but if the degree | |||
of the fit polynomial is higher than 1, the minimal number of data points | |||
the degree of the fit polynomial | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So we use docstrings in the methods and not a methods section. I'll try to remember in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, both works, but generally I like the docs to be as close to the code as possible.
@JGuetschow merge yourself if you are happy (will merge into your branch, not into main directly) |
@JGuetschow it was easier for me to add my refactorings as patches instead of doing them inline in github, so I created a PR into your branch with what I would change in your branch before merging. Changes: