search

open-forest-observatory / geograypher

Enabling Geospatial Predictions from Individual Drone Images
https://open-forest-observatory.github.io/geograypher/
BSD 3-Clause "New" or "Revised" License
11 stars 5 forks source link

Ensure full method docstring coverage #25

Open russelldj opened 11 months ago

russelldj commented 11 months ago

I've gotten lazy with some recent PRs and haven't made sure all the functions/methods have docstrings. This should be addressed. A lower-priority task would be ensuring that all docstrings are up to date and reflect the current arguments. I personally use VSCode autoDocstring to do the templating.

russelldj commented 3 months ago

It might be useful to explore pydoctest as a way to help with this.

russelldj commented 2 months ago

It would be useful for the docs pages to have some more summary content. We should look into whether there are more opportunities to include this in the actual files (e.g. can you have a file-level docstring?) and if not include it in the docs folder.