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 secDisclaimer. KwickAcademy is free study material for general learning and revision. Parts of it, including the voice-over, are produced with the help of AI tools and may contain errors; if you spot one, please tell us and we will correct it. Syllabus, marks and exam details follow the latest official board publications available to us, and boards can change them at any time, so always confirm against your board's official website and your school. Using this material does not guarantee any marks or result. Board names and trademarks belong to their owners; Kwickprep is not affiliated with or endorsed by any examination board. We never ask for passwords, OTPs or ID numbers. Your progress is saved only in this browser. Full disclaimer · Privacy