-
Notifications
You must be signed in to change notification settings - Fork 659
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
Add warning for future change of argument name for timeseries
from asel
-> atomgroup
#4343
Conversation
Hello @hmacdope! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:
Comment last updated at 2023-12-03 04:13:44 UTC |
Linter Bot Results:Hi @hmacdope! Thanks for making this PR. We linted your code and found the following: Some issues were found with the formatting of your code.
Please have a look at the Please note: The |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #4343 +/- ##
==========================================
Coverage 93.36% 93.37%
==========================================
Files 170 184 +14
Lines 22325 23453 +1128
Branches 4079 4085 +6
==========================================
+ Hits 20844 21899 +1055
- Misses 963 1036 +73
Partials 518 518 ☔ View full report in Codecov by Sentry. |
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.
Cheers, couple of things though.
@@ -1023,6 +1023,12 @@ def timeseries(self, asel: Optional['AtomGroup']=None, | |||
|
|||
.. versionadded:: 2.4.0 | |||
""" | |||
if asel: |
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.
Same as above, we should support both keyword arguments and docs should reflect this.
@@ -525,6 +525,12 @@ def timeseries(self, asel=None, start=0, stop=-1, step=1, order='afc'): | |||
ValueError now raised instead of NoDataError for empty input | |||
AtomGroup | |||
""" | |||
if asel: |
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.
As above
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.
Done :)
Co-authored-by: Irfan Alibay <[email protected]>
@IAlibay still WIP ill ping for review when ready |
@hmacdope given your comment above I converted it to a draft for now. |
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.
Cheers
Fixes #3911
Changes made in this Pull Request:
timeseries
fromasel
toatomgroup
.PR Checklist
Developers certificate of origin
📚 Documentation preview 📚: https://mdanalysis--4343.org.readthedocs.build/en/4343/