MDAnalysis / membrane-curvature

MDAnalysis tool to calculate membrane curvature.

https://membrane-curvature.readthedocs.io/

GNU General Public License v3.0

29 stars 6 forks source link

Added membrane curvature units info to docstrings #82

Closed ojeda-e closed 2 years ago

ojeda-e commented 2 years ago

This PR fixes #80 (thanks @hmacdope for catching this!).

[x] Added curvature units to docstrings in notes.
[x] Updated previous note (now warning).

Let me know if I am missing important details.

pep8speaks commented 2 years ago

Hello @ojeda-e! 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! :beers:

Comment last updated at 2021-10-01 15:34:27 UTC

codecov[bot] commented 2 years ago

Codecov Report

Merging #82 (654812d) into main (385fffa) will not change coverage. The diff coverage is n/a.

lilyminium commented 2 years ago

This is a nice lengthy explanation, but it would also be useful to just quickly note the units in the MembraneCurvature class, like "Calculates Gaussian curvature (in 1/A^2) and mean curvature (in 1/A)". Otherwise you really depend on people clicking to this page and reading the documentation, instead of, e.g. going help(MembraneCurvature).

ojeda-e commented 2 years ago

Thanks @hmacdope and @lilyminium for catching these details! I added a line in the MembraneCurvature class.