fix read_results doc

OSeMOSYS · Sep 23, 2024 · 2d83757 · 2d83757
1 parent efe0e17
commit 2d83757
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/convert.rst b/docs/convert.rst
@@ -34,11 +34,11 @@ See :func:`otoole.convert.convert_results` for more details
 Reading solver results into a dict of Pandas DataFrames
 -------------------------------------------------------
 
-The ``read_results`` function reads a CBC_, CLP_,
-Gurobi_ or CPLEX_ solution file into memory::
+The ``read_results`` function reads a CBC_, CLP_, Gurobi_ or CPLEX_ solution file into to a Python object.
+This allows you to then use all the features offered by Python to manipulate the data.
 
 >>> from otoole import read_results
->>> read_results('my_model.yaml', 'cbc', 'csv', 'my_model.sol', 'my_model_csvs', 'datafile', 'my_model.dat')
+>>> data, defaults = read_results('my_model.yaml', 'cbc', 'my_model.sol', 'datafile', 'my_model.dat')
 
 See :func:`otoole.convert.read_results` for more details