[issue46126] Unittest output drives developers to avoid docstrings

Jason R. Coombs report at bugs.python.org
Sat Jan 1 15:37:05 EST 2022


Jason R. Coombs <jaraco at jaraco.com> added the comment:

> > I presume I don't need to explain why docstrings are nice and preferable over comments.

> Actually, can you?

I searched around and didn't find any good treatise or thorough overview  of reasons _why_ docstrings should be preferred, so I performed an internal deconstruction of my motivations and published [this article](https://blog.jaraco.com/why-docstrings-are-preferable-to-comments/) on my blog.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue46126>
_______________________________________


More information about the Python-bugs-list mailing list