26
Are docstrings commonly used?
(programming.dev)
Welcome to the Python community on the programming.dev Lemmy instance!
Past
November 2023
October 2023
July 2023
August 2023
September 2023
Yes they are sometimes used, as is doctest, but Python's built in help system isn't as good as it could be, so the docstrings aren't that useful. Most annoyingly, for built in library classes, help(whatever) spews machine generated prototypes at you before you get any actual documentation.
I generally like to write some kind of explanatory text along with any nontrivial function that I write, but I'm not very consistent about doing this as a doctring vs as a code comment. I do use type annotations heavily nowadays.