Python π docstrings π are very important, because they are the first level of documentation of your code.
Docstrings are great because IDEs can often display them, to give you help, when you start using a function.
Here's some advice on how to write them ππ§΅
Docstrings are great because IDEs can often display them, to give you help, when you start using a function.
Here's some advice on how to write them ππ§΅
The first line of a docstring should be a short sentence explaining, in English, what the function does.
Write the docstring as a command, not as a long-winded description of what is going to happen.
Go straight to the point, make that line count!
Write the docstring as a command, not as a long-winded description of what is going to happen.
Go straight to the point, make that line count!
If the function isn't trivial, you need to write a more complete docstring.
Explain what the arguments do and the return value.
Explain what/when the function raises errors.
Let the user know of any side-effects that might happen.
...
Write all of this after a blank line.
Explain what the arguments do and the return value.
Explain what/when the function raises errors.
Let the user know of any side-effects that might happen.
...
Write all of this after a blank line.
Try to get in the habit of writing docstrings for ALL your functions.
You will get used to it quickly, and it will start to pay off dividends even more quickly!
There's much more to be said about docstrings, but I'll sign off for now.
See you soon π
You will get used to it quickly, and it will start to pay off dividends even more quickly!
There's much more to be said about docstrings, but I'll sign off for now.
See you soon π
β’ β’ β’
Missing some Tweet in this thread? You can try to
force a refresh
γ
