Skip to content

Commit 28b7d11

Browse files
committed
Adding Informational PEPs
1 parent 1599cd8 commit 28b7d11

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

coding-conventions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
* Function and Method arguments - Always use `self` for the first argument to instance methods and `cls` for the first argument to class methods.
1111
* Constants - Constants are usually defined on a module level and written in all capital letters with underscores separating words, e.g. `BUCKET_NAME` and `THRESHOLD`.
1212

13+
### Types
14+
#### Informational
15+
Informational PEPs describe a Python design issue, or provide general guidelines or information to the Python community. Some examples of informational PEPs are [PEP-20](https://peps.python.org/pep-0020/) (The Zen of Python), and [PEP-257](https://peps.python.org/pep-0257/) (Docstring conventions).
16+
1317
## [Docstrings](https://peps.python.org/pep-0257/)
1418
* For one-liner docstrings, the closing `"""` should be on the same line
1519
* The `"""` that ends a multiline docstring should be on a line by itself. For consistency, always use triple double quotes around docstrings.

0 commit comments

Comments
 (0)