this post was submitted on 05 Apr 2025
24 points (92.9% liked)

Python

7021 readers
1 users here now

Welcome to the Python community on the programming.dev Lemmy instance!

๐Ÿ“… Events

PastNovember 2023

October 2023

July 2023

August 2023

September 2023

๐Ÿ Python project:
๐Ÿ’“ Python Community:
โœจ Python Ecosystem:
๐ŸŒŒ Fediverse
Communities
Projects
Feeds

founded 2 years ago
MODERATORS
 

Was going through a Python tutorial, but it seems kinda dated. Wanted to know if people regularly use docstrings in the workforce. Or are they somewhat irrelevant because you can convey most of that info via comments and context? Do jobs make you use them?

you are viewing a single comment's thread
view the rest of the comments
[โ€“] [email protected] 4 points 2 weeks ago

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.