search

AnabelSMRuggiero / sbmltoodepy

A tool for creating Python implementations of SBML models.
BSD 3-Clause "New" or "Revised" License
13 stars 4 forks source link

JOSS reviewer 2 comment 3 #4

Closed marouenbg closed 5 years ago

marouenbg commented 5 years ago

Review openjournals/joss-reviews#1643

my last minor comment has to do with the documentation website which already covers automatically the functions description. If possible, I suggest to organize it as introduction, full installation guide, troubleshooting, function description (expand if possible beyond the argument specification), tutorials (paste your tutorials here), and changelog of the documentation.

AnabelSMRuggiero commented 5 years ago

We have added in both the readme and tutorial to our documentation page. While we see the value in a troubleshooting section of the documentation, we think we need user feedback before creating it. We plan on adding a changelog section to the documentation as part of finishing addressing reviewer feedback.