24
Are docstrings commonly used? (programming.dev)
submitted 1 week ago by 3rr4tt1c@programming.dev to c/python@programming.dev
15 comments fedilink hide all child comments

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
[-] TootSweet@lemmy.world 9 points 1 week ago

Yup, use docstrings and be descriptive. Learn by reading docstrings in other codebases. (Django's codebase is always an excellent example of how to do Python, including how to do docstrings.) a) Anyone who sees your code will thank you and b) if you can't explain it in human language, you probably don't understand it well enough to implement it well.

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

Python

7006 readers
14 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
erlingur@programming.dev
jnovinger@programming.dev
norambna@programming.dev