@@ -205,7 +205,7 @@ another Python project, make sure to use the same style as rest of that project
205
205
is using.
206
206
207
207
If you are starting a new project, then you can use whichever style you
208
- want, but don't "reinventing the wheel"; use an existing style instead instead of
208
+ want, but don't "reinvent the wheel"; use an existing style instead instead of
209
209
making up your own. Here are some examples of popular docstring styles to choose
210
210
from:
211
211
@@ -333,9 +333,8 @@ class Vehicles:
333
333
334
334
## When should we use docstrings?
335
335
336
- Always use docstrings when writing code that other people will import.
337
- The ` help() ` function is awesome, so it's important to make sure it's
338
- actually helpful.
336
+ I recommend using docstrings when writing code that other people will import.
337
+ The ` help() ` function is awesome, so it's good to make sure it's actually helpful.
339
338
340
339
If your code is not meant to be imported, docstrings are usually a good
341
340
idea anyway. Other people reading your code will understand what it's
@@ -347,7 +346,7 @@ doing without having to read through all of the code.
347
346
- A ` """triple-quoted string""" ` string in the beginning of a function,
348
347
class or file is a docstring. It shows up in ` help() ` .
349
348
- Docstrings are not comments.
350
- - Usually it's a good idea to add docstrings everywhere
349
+ - Usually it's a good idea to add docstrings everywhere.
351
350
352
351
***
353
352
0 commit comments