KwickClips Python · 39 sec · free
Where does a docstring go?
Short answer. As the first line inside the function.
What is the difference between a docstring and a comment?
A docstring says what; a comment says why.
Remember
| Docstring: what it does |
| Comment: why it is done |
A docstring says what. A comment says why. Where does each go? A docstring, in triple quotes, is the first line in a function. Python keeps it, and dunder doc prints it. A docstring says what. A hash comment says why.
This clip is from the full lesson: Organising, Testing and Documenting Python Code — 7 minutes, with the tables, the quick answers and the whole lesson in text.
Useful for: Programming All levels Python
More KwickClips from this lesson
What should a function do?40 sec
What naming style do Python functions use?44 sec
What does assert do?38 secVoice-over is AI-generated; the script is written and checked by Kajal Ma'am. Confirm anything you plan around against your official board document. We never ask for a password or an OTP.