OSeMOSYS / otoole

OSeMOSYS Tools for Energy
https://otoole.readthedocs.io
MIT License
25 stars 18 forks source link

[DOCS]: Incorrect syntax in the Python API page for Reading results #231

Closed vignesh1987 closed 1 month ago

vignesh1987 commented 1 month ago

Type of documentation issue.

Incorect Information

Issue Description

On the Python API page, the section on reading result files has a syntax error. It read as follows from otoole import read_results read_results('my_model.yaml', 'cbc', 'csv', 'my_model.sol', 'my_model_csvs', 'datafile', 'my_model.dat')

However, it should be as follows. The syntax does not need the CSV definition, as we are just creating a Tuple from the results. from otoole import read_results read_results('my_model.yaml', 'cbc', 'my_model.sol', 'datafile', 'my_model.dat')

The syntax in the module reference page of otoole.convert.read_results() is correct

Link to existing documentation

https://otoole.readthedocs.io/en/latest/convert.html

Suggested Update

The syntax should be read_results('my_model.yaml', 'cbc', 'my_model.sol', 'datafile', 'my_model.dat')

Additional Info

No response

trevorb1 commented 1 month ago

Thanks for reporting and including the clear solution, @vignesh1987! Should be fixed now :)