Skip to content

Commit

Permalink
Merge pull request #190 from marrink-lab/name-docstring
Browse files Browse the repository at this point in the history
Augments the docstring of name_moltype.py
  • Loading branch information
jbarnoud committed Feb 19, 2019
2 parents 9533061 + 8d8f030 commit d90285d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion vermouth/processors/name_moltype.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@
# limitations under the License.

"""
Assign moltype names to molecules.
Provides a processor to assign molecule type names to molecules.
A molecule type (moltype) is Gromacs's concept of a molecule. Providing a name
for a molecule type is required to write an ITP file for that molecule. We also
use the molecule type name to group molecules sharing the same molecule type.
Molecule type identity is tested based on
:meth:`vermouth.molecule.Molecule.share_moltype_with`.
"""

from .processor import Processor
Expand Down

0 comments on commit d90285d

Please sign in to comment.