ericfell / rfbzero

Redox flow battery electrochemical cycling models in Python
https://rfbzero.readthedocs.io/en/latest/index.html
MIT License
3 stars 1 forks source link

[JOSS Review] - Suggestions for the documentation #37

Closed MaximevdHeijden closed 4 months ago

MaximevdHeijden commented 5 months ago

Dear authors,

Some very minor suggestions for the documentation:

This issue is related to https://github.com/openjournals/joss-reviews/issues/6537

ericfell commented 5 months ago

Thank you for the suggestions.

Regarding the first bullet point, we've added the installation section to the documentation examples notebook in #40, and the same information can be found on the homepage readthedocs for rfbzero.

Regarding the second point, we've opened issue #41 as a feature request to include current-driven crossover. Guiding information for this feature is provided there.

related to openjournals/joss-reviews#6537