openfoodfacts-dart icon indicating copy to clipboard operation
openfoodfacts-dart copied to clipboard

Published 20 hours ago • verified publisher icon openfoodfacts

Rewriting documentation

Open M123-dev opened this issue 2 years ago • 2 comments

M123-dev avatar Dec 22 '21 15:12 M123-dev

Currently we have an outdated DOCUMENTATION.md, now I ask myself, if we should stick with this or if we should rather add more comments to the mainly used methods and then refer to the automatically generated documentation found here: https://openfoodfacts.github.io/openfoodfacts-dart/

@monsieurtanuki, any preferences here?

M123-dev avatar Dec 22 '21 15:12 M123-dev

@M123-dev I don't read documentation, I read code. So my suggestion is: we should add proper /// comments, and let the documentation generator work on top of it for whoever reads documentation but not code. And if needed add examples or tests, and link to them from README.md.

monsieurtanuki avatar Dec 22 '21 17:12 monsieurtanuki