RSE-Sheffield / software_engineering_best_practices

http://rse.shef.ac.uk/software_engineering_best_practices/
Other
4 stars 1 forks source link

Motivation for documentation #9

Closed davidwilby closed 3 years ago

davidwilby commented 3 years ago

Could just be covered verbally, but I think there is good, research-relevant motivation for testing and licensing but there is perhaps some missing motivation for "why should I, as a researcher, write docstrings?"

bobturneruk commented 3 years ago

Agreed. I suggest we have some slides to introduce this.

bobturneruk commented 3 years ago

https://merely-useful.tech/py-rse/documentation.html