search

SMTG-Bham / ThermoParser

A tool for streamlining data analysis and visualisation for thermoelectrics and charge carrier transport in computational materials science.
https://smtg-bham.github.io/ThermoParser/
GNU Affero General Public License v3.0
46 stars 14 forks source link

[joss review] Python API documentation #82

Closed fnattino closed 7 months ago

fnattino commented 7 months ago

The Python Package section of the documentation is quite difficult to read. Could it be improved by improving structuring and/or formatting?

For instance, functions seems to be listed twice in each module, the first time of which without any description/information (see e.g. https://smtg-bham.github.io/ThermoParser/tp.axes.html#functions). Also, some descriptions are quite "uninformative" (e.g. the top one: https://smtg-bham.github.io/ThermoParser/tp.html#tp-package), maybe these could be removed.

Also, I would name this section "Python API" in order to make it clearer what this section is actually about.

JOSS review issue

kbspooner commented 7 months ago

Ah this seems to be a hangover from before using sphinx. I've removed all of the duplication (I think) and modified some of the docstrings, as well as the Python API title.

fnattino commented 7 months ago

Nice, much more readable now, thanks!