Skip to content

Commit eab43ce

Browse files
committed
Added docstrings in some QM classes
Attributes were not included in some of the base qm classes. They are now.
1 parent 266fff2 commit eab43ce

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

rmgpy/qm/main.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ class QMCalculator():
8181
=================== ======================= ====================================
8282
Attribute Type Description
8383
=================== ======================= ====================================
84-
`settings` ``QMSettings`` Settings for QM calculations
85-
`database` ``ThermoLibrary`` Database containing QM calculations
84+
`settings` :class:`QMSettings` Settings for QM calculations
85+
`database` :class:`ThermoLibrary` Database containing QM calculations
8686
=================== ======================= ====================================
8787
8888
"""

rmgpy/qm/molecule.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,19 @@ class Geometry:
2323
A geometry, used for quantum calculations.
2424
2525
Created from a molecule. Geometry estimated by RDKit.
26+
27+
The attributes are:
28+
29+
=================== ======================= ====================================
30+
Attribute Type Description
31+
=================== ======================= ====================================
32+
`settings` :class:`QMSettings` Settings for QM calculations
33+
`uniqueID` ``str`` A short ID such as an augmented InChI Key
34+
`molecule` :class:`Molecule` RMG Molecule object
35+
`multiplicity` ``int`` The multiplicity of the molecule
36+
`uniqueIDlong` ``str`` A long, truly unique ID such as an augmented InChI
37+
=================== ======================= ====================================
38+
2639
"""
2740
def __init__(self, settings, uniqueID, molecule, multiplicity, uniqueIDlong=None):
2841
self.settings = settings
@@ -169,6 +182,18 @@ class QMMolecule:
169182
* outputFileExtension
170183
* inputFileExtension
171184
* generateQMData() ...and whatever else is needed to make this method work.
185+
186+
The attributes are:
187+
188+
=================== ======================= ====================================
189+
Attribute Type Description
190+
=================== ======================= ====================================
191+
`molecule` :class:`Molecule` RMG Molecule object
192+
`settings` :class:`QMSettings` Settings for QM calculations
193+
`uniqueID` ``str`` A short ID such as an augmented InChI Key
194+
`uniqueIDlong` ``str`` A long, truly unique ID such as an augmented InChI
195+
=================== ======================= ====================================
196+
172197
"""
173198

174199
def __init__(self, molecule, settings):

0 commit comments

Comments
 (0)