Open mikewolfe opened 5 years ago
I think this is a good idea. It would give the learners a better idea of what docstrings are useful for.
@mikewolfe if you're still there after all these years (sorry, I'm going through the backlog of issues), would you be interested in submitting a PR?
In the Programming Style lesson the google style guide for writing function docstrings is mentioned, but the style of the example docstrings in the lesson do not follow the google style guide. It may be worth introducing users to the idea of a google style function docstring like the example in the google style guide:
This would force new users to think about what a function does, what inputs it takes in, and what output it returns, thereby encouraging good style practices and reinforcing the learning goals for functions at the same time.