Skip to content

Commit 126ec0e

Browse files
committed
small fixes
1 parent d0e9978 commit 126ec0e

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

basics/docstrings.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ another Python project, make sure to use the same style as rest of that project
205205
is using.
206206

207207
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
209209
making up your own. Here are some examples of popular docstring styles to choose
210210
from:
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

340339
If your code is not meant to be imported, docstrings are usually a good
341340
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.
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

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy