Closed SShilo closed 7 years ago
auxi version: 0.3.1 Python version: 3.5.2 OS details: Win 10, 32-bit
Within the doc string of the module/function amounts, a typo on the usage of dictionaries can be seen on the definition of #param masses.
def amounts(masses): """ Calculate the amounts from the specified compound masses. :param masses: [kg] dictionary, e.g. {'SiO2': 3.0, 'FeO'##, 1.5} :returns: [kmol] dictionary
The param masses line should say: :param masses: [kg] dictionary, e.g. {'SiO2':3.0 , 'FeO'##:1.5}
:param masses: [kg] dictionary, e.g. {'SiO2':3.0 , 'FeO'##:1.5}
Improve doc string to make implementation of module easier.
Replace comma (,) with a colon (:).
System Details
auxi version: 0.3.1 Python version: 3.5.2 OS details: Win 10, 32-bit
Background
Within the doc string of the module/function amounts, a typo on the usage of dictionaries can be seen on the definition of #param masses.
The param masses line should say:
:param masses: [kg] dictionary, e.g. {'SiO2':3.0 , 'FeO'##:1.5}Purpose
Improve doc string to make implementation of module easier.
Approach
Replace comma (,) with a colon (:).