Skip to content

Commit b4c72fc

Browse files
committed
Wrote a short introduction to the patterns book.
1 parent 4a77bf9 commit b4c72fc

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/index.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,30 @@ Welcome
88

99
:github_badge:`quantifiedcode/python-code-patterns`
1010

11+
Welcome, fellow Pythoneer! This is an open collection of Python **code anti-patterns**. The goal of
12+
this document is to show you how *NOT* to do things. In each document shown below, you will find an
13+
example of badly written or problematic Python code, together with an easy-to-understand explanation
14+
of the issues found in the code, and a proposed solution.
15+
16+
Many of the issues that we discuss here can be detected automatically using code analysis, e.g. using
17+
Pylint, PyChecker or PEP8. You can also check many of these pattern online on our wrbsite, QuantifiedCode.
18+
19+
Licensing
20+
---------
21+
22+
This document is licensed under a creative-commons NC license, so you can use the text freely
23+
for non-commercial purposes and adapt it to your needs. The only thing we ask in return is the
24+
inclusion of a link to this page, so that your readers might find the content in its original form.
25+
26+
Contributing
27+
------------
28+
29+
If you think this collection can be improved or extended, please contribute! You can do this by
30+
simply forking our Github project and sending us a pull request once you're done adding your changes.
31+
We will review and merge all pull requests as fast as possible and be happy to include your name on
32+
the list of authors of this document.
33+
34+
1135
.. toctree::
1236
:glob:
1337
:maxdepth: 2

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