search

chloroExtractorTeam / chloroExtractor

MIT License
4 stars 8 forks source link

[Review] Documentation - API documentation #13

Closed iimog closed 7 years ago

iimog commented 7 years ago

Reviewers should check that the software API is documented to a suitable level. This decision is left largely to the discretion of the reviewer and their experience of evaluating the software.

Good: All functions/methods are documented including example inputs and outputs OK: Core API functionality is documented Bad (not acceptable): API is undocumented

iimog commented 7 years ago

I think in our case this refers to the command line parameters and the config file. In my opinion both are sufficiently but not excessively documented.