search

thermohub / thermofun

A code for calculating the standard state thermodynamic properties at a given temperature and pressure.
https://thermohub.org/thermofun/thermofun/
GNU Lesser General Public License v2.1
26 stars 8 forks source link

[JOSS] Doc strings for python api #52

Closed hgandhi2411 closed 1 year ago

hgandhi2411 commented 1 year ago

The documentation on thrrmofun.org is good and also has examples. But it would be more accessible if you had doc strings for different methods available. Right now it's hard to tell what methods are available besides those in the example.

fnattino commented 1 year ago

I agree with @hgandhi2411 that API documentation, as part of both docstrings and online documentation, would be very helpful!