Skip to content

Commit c1da2ed

Browse files
committed
Fix language in docstrings
Signed-off-by: Ugochukwu Nwosu <ugognw@gmail.com>
1 parent 453b74a commit c1da2ed

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

src/pyEQL/benchmark.py

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -140,16 +140,15 @@ def load_dataset(
140140
solutions: list[Solution], optional
141141
The solutions for which data will be loaded from the dataset. If provided, only data corresponding to
142142
solutions with the same composition, temperature, and pressure will be loaded. If omitted, all
143-
compositions and conditions in the reference data contained in ``sources`` will be used for the
144-
benchmarking.
143+
compositions and conditions in the reference data contained in ``source`` will be loaded.
145144
solute_properties: list[tuple[str, str]], optional
146-
The solute properties to include in the benchmarking, specified as ``(solute, property)``. The engine will
147-
only be benchmarked against those solute properties listed here. If omitted, the engine will be benchmarked
148-
against all solute properties in ``sources``.
145+
The solute properties to loaded from the datased, specified as ``(solute, property)``. If provided, only
146+
data for the specified solute properties will be loaded. If omitted, all solute properties in the reference
147+
data contained in ``source`` will be loaded.
149148
solution_properties: list[str], optional
150-
The solution properties to include in the benchmarking. The engine will only be benchmarked against those
151-
solution properties listed here. Defaults to None in which case the engine will be benchmarked against all
152-
solute properties in ``sources``.
149+
The solution properties to loaded from the datased`. If provided, only data for the specified solution
150+
properties will be loaded. If omitted, all solution properties in the reference data contained in ``source``
151+
will be loaded.
153152
154153
Returns:
155154
A dictionary mapping SolutionKey to BenchmarkEntry objects. See the comment over SolutionKey for details about
@@ -411,8 +410,8 @@ def benchmark_engine(
411410
One of INTERNAL_SOURCES or the path to a JSON file that can be read into a list of BenchmarkEntry
412411
objects. Defaults to INTERNAL_SOURCES.
413412
solutions: list[Solution], optional
414-
The solutions for which data will be loaded from the dataset. If provided, only data corresponding to
415-
solutions with the same components, concentrations, and conditions (temperature, pressure) will be loaded.
413+
The solutions to include n the benchmarking. If provided, only data corresponding to
414+
solutions with the same components, concentrations, and conditions (temperature, pressure) will be used.
416415
If omitted, reference data for all components, concentrations, and conditions (temperature, pressure)
417416
contained in ``sources`` will be used for the benchmarking.
418417
solute_properties: list[tuple[str, str]], optional

0 commit comments

Comments
 (0)