@@ -205,7 +205,7 @@ another Python project, make sure to use the same style as rest of that project
205205is using.
206206
207207If 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
209209making up your own. Here are some examples of popular docstring styles to choose
210210from:
211211
@@ -333,9 +333,8 @@ class Vehicles:
333333
334334## When should we use docstrings?
335335
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.
339338
340339If your code is not meant to be imported, docstrings are usually a good
341340idea 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.
347346- A ` """triple-quoted string""" ` string in the beginning of a function,
348347 class or file is a docstring. It shows up in ` help() ` .
349348- 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.
351350
352351***
353352
0 commit comments