Embedded Files
Wait... We can document automatically?
Wait... We can document automatically?
📌 What is a Python Docstring?
📌 What is a Python Docstring?
A docstring is a multi-line string (written in triple quotes """ """ or ''' ''') that is placed inside a function, class, or module. It describes what the function does.
✅ The answer: It makes your code easier to read, organize, and reuse!
🛠️ Basic Example
🛠️ Basic Example
If I was to document my function like this, I would be able to get the output shown below:
👑 These can be simple 1 line documentations:
👑 These can be simple 1 line documentations:
👑 These can be documenting a class
👑 These can be documenting a class
👑 Or, we can even document a module...
👑 Or, we can even document a module...
Differences between these and comments
Differences between these and comments
📌 Docstring Formatting (PEP 257)
📌 Docstring Formatting (PEP 257)
Python follows PEP 257 guidelines for writing clean and structured docstrings.
Common styles:
✅ One-liner: For very simple functions.
✅ Multi-line docstring: For more complex functions with parameters and return values.
Page updated
Report abuse