Example in API docs displays incorrect import

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

Example in API docs displays incorrect import #71

Closed ojeda-e closed 3 years ago

ojeda-e commented 3 years ago

The example provided in the docstrings of base.py displays an incorrect import: from MDAnalysis.analysis import MembraneCurvature, that should be from membrane_curvature.base import MembraneCurvature. A link that redirects to Usage after the example provided may be useful for the user.

To fix this issue:

[x] Change import.
[x] Add a link to redirect to specific examples.