Skip to content

Deprecate helanal#2928

Merged
orbeckst merged 4 commits intoMDAnalysis:backport-1.0.1from
lilyminium:deprecate-helanal
Sep 4, 2020
Merged

Deprecate helanal#2928
orbeckst merged 4 commits intoMDAnalysis:backport-1.0.1from
lilyminium:deprecate-helanal

Conversation

@lilyminium
Copy link
Member

Changes made in this Pull Request:

Sorry for the delay in adding the helanal deprecation notice.

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Couple of changes, probably would be worth switching over to the deprecate decorator. Also we'll need to test warnings (or at least fix the test for warnings).

import logging
logger = logging.getLogger("MDAnalysis.analysis.helanal")

warnings.warn("This module is deprecated as of MDAnalysis version 1.0. "
Copy link
Member

Choose a reason for hiding this comment

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

We'll probably want some test for this? (not sure how strict we are being with 1.0.1 tests, but if it's getting released we should try to get coverage down?)

Copy link
Member

Choose a reason for hiding this comment

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

Actually the tests are failing here, so we it'll need fixing anyways.

@orbeckst
Copy link
Member

orbeckst commented Sep 2, 2020

Just fyi, you can also make a PR against master, that's fine, too.

@orbeckst orbeckst mentioned this pull request Sep 3, 2020
4 tasks
@pep8speaks
Copy link

pep8speaks commented Sep 4, 2020

Hello @lilyminium! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-09-04 07:33:03 UTC

@codecov
Copy link

codecov bot commented Sep 4, 2020

Codecov Report

Merging #2928 into backport-1.0.1 will decrease coverage by 0.20%.
The diff coverage is n/a.

Impacted file tree graph

@@                Coverage Diff                 @@
##           backport-1.0.1    #2928      +/-   ##
==================================================
- Coverage           92.00%   91.80%   -0.21%     
==================================================
  Files                 169       15     -154     
  Lines               23175     2025   -21150     
  Branches             3186        0    -3186     
==================================================
- Hits                21322     1859   -19463     
+ Misses               1760      166    -1594     
+ Partials               93        0      -93     
Impacted Files Coverage Δ
package/MDAnalysis/coordinates/NAMDBIN.py
package/MDAnalysis/lib/formats/__init__.py
package/MDAnalysis/analysis/hole2/__init__.py
package/MDAnalysis/selections/jmol.py
...kage/MDAnalysis/analysis/hydrogenbonds/__init__.py
package/MDAnalysis/coordinates/XTC.py
package/MDAnalysis/topology/MinimalParser.py
package/MDAnalysis/tests/__init__.py
...DAnalysis/analysis/hydrogenbonds/hbond_analysis.py
package/MDAnalysis/coordinates/TRR.py
... and 143 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4173028...f1810ee. Read the comment docs.

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

lgtm, just a couple of comments that might be worth considering.

@orbeckst since this is going into your 1.0.1 PR I'll let you do the merge?

@orbeckst orbeckst self-assigned this Sep 4, 2020
@orbeckst orbeckst merged commit f64dadd into MDAnalysis:backport-1.0.1 Sep 4, 2020
@orbeckst
Copy link
Member

orbeckst commented Sep 4, 2020

Thank you @lilyminium and thanks @IAlibay for the review!

orbeckst pushed a commit that referenced this pull request Sep 4, 2020
* deprecate helanal, to be removed in 2.0.0 (use analysis.helix_analysis in 2.0 from PR #2622)
* add deprecation warnings to analysis.helanal
* update CHANGELOG
@fiona-naughton fiona-naughton added maintainability Component-Analysis deprecation Deprecated functionality to give advance warning for API changes. labels Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component-Analysis deprecation Deprecated functionality to give advance warning for API changes. maintainability

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants