Skip to content

Commit 78b9536

Browse files
enochdrwest
authored andcommitted
Tweak the chemkin docstrings and documentation.
Written by: Enoch Dames <enoch.dames@gmail.com> Rebased by: Richard West <r.west@neu.edu>
1 parent 267fa55 commit 78b9536

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

rmgpy/chemkin.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -726,14 +726,15 @@ def loadTransportFile(path, speciesDict):
726726

727727
def loadChemkinFile(path, dictionaryPath=None, transportPath=None, readComments = True, thermoPath = None):
728728
"""
729-
Load a Chemkin input file to `path` on disk, returning lists of the species
730-
and reactions in the Chemkin file.
729+
Load a Chemkin input file located at `path` on disk to `path`, returning lists of the species
730+
and reactions in the Chemkin file. The 'thermoPath' point to a separate thermo file, or, if 'None' is
731+
specified, the function will look for the thermo database within the chemkin mechanism file
731732
"""
732733

733734
speciesList = []; speciesDict = {}; speciesAliases = {}
734735
reactionList = []
735736

736-
# If the dictionary path is given, the read it and generate Molecule objects
737+
# If the dictionary path is given, then read it and generate Molecule objects
737738
# You need to append an additional adjacency list for nonreactive species, such
738739
# as N2, or else the species objects will not store any structures for the final
739740
# HTML output.

0 commit comments

Comments
 (0)