Skip to content

Commit f87edef

Browse files
rwestsevyharris
authored andcommitted
Tweak docstrings
1 parent a0cda57 commit f87edef

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

pyked/chemked.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,9 @@ class DataPoint(object):
591591
Specific types of data point should inherit from this.
592592
"""
593593
def process_quantity(self, properties):
594-
"""Process the uncertainty information from a given quantity and return it
594+
"""
595+
Process the units and uncertainty information from a given quantity
596+
and return it as a units.Quantity object.
595597
"""
596598
quant = Q_(properties[0])
597599
if len(properties) > 1:
@@ -632,10 +634,10 @@ def process_quantity(self, properties):
632634

633635

634636
class IgnitionDataPoint(DataPoint):
635-
"""Class for a single datapoint.
637+
"""Class for a single ignition delay datapoint.
636638
637-
The `DataPoint` class stores the information associated with a single data point in the dataset
638-
parsed from the `ChemKED` YAML input.
639+
The `IgnitionDataPoint` class stores the information associated with a single ignition data point
640+
in the dataset parsed from the `ChemKED` YAML input.
639641
640642
Arguments:
641643
properties (`dict`): Dictionary adhering to the ChemKED format for ``datapoints``

0 commit comments

Comments
 (0)