pyOpenSci / lessons

A repo containing lessons used in pyOpenSci training.
https://www.pyopensci.org/lessons
BSD 3-Clause "New" or "Revised" License
3 stars 4 forks source link

Add: lesson on the different ways to document code #89

Open lwasser opened 1 week ago

lwasser commented 1 week ago

https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html

We have the above page in our guidebook but a more robust page on the different types of documentation and how to add it would be useful. This would include

Notes on how docstrings become critical when adding API docs (as a small section at the end).

sneakers-the-rat commented 1 week ago

There are a few of these floating around from CSCW/STS people that are better than this, but a typology of documentation i find helpful:

would be nice to have an overview like this somewhere, I think it's in a few places and in the structure of that section of the guide, but seems like "overview" material :)

(sorry if this isn't waht you meant in this issue)