gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Adding alternative tools for coding style (#30493)

Browse Source 
* Adding alternative tools for coding style

Adding alternative tools for coding style

* fix: changed console to shell
This commit is contained in:
van-tienhoang
2019-05-18 08:42:07 -04:00
committed by Parth Parth
parent 1485959f5a
commit 3366d820a7
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
guide/english/python/python-coding-standards/index.md
View File

@ -6,6 +6,7 @@ title: Coding standards
* Why coding standards? * Why coding standards?
* Intro to PEP 8 * Intro to PEP 8
* Commands * Commands
* Alternative tools
### Why coding standards? ### Why coding standards?
The global python community is rapidly growing, and almost everyone uses python. This is where readability of code and uniform standards matter. *Anyone on the planet should be able to read your code and understand what it does*. There are a lot of aspects to understanding other's code, for example comments about what a function does, logically dividing tasks among modules and functions, good variable names, etc. The global python community is rapidly growing, and almost everyone uses python. This is where readability of code and uniform standards matter. *Anyone on the planet should be able to read your code and understand what it does*. There are a lot of aspects to understanding other's code, for example comments about what a function does, logically dividing tasks among modules and functions, good variable names, etc.
@ -19,9 +20,16 @@ We love sticking to conventions. The python user community has come up with a se
Here's how you check if your python code meets he standards. Here's how you check if your python code meets he standards.
```console ```shell
:~$ pip install pep8 :~$ pip install pep8
:~$ pep8 --first myCode.py :~$ pep8 --first myCode.py
``` ```
This will give all those lines which violate the standards, along with a short description of the fixes. This will give all those lines which violate the standards, along with a short description of the fixes.
### Alternative tools
Beside `pep8`, there are some other tools with same functionalities:
* [pylint](https://www.pylint.org)
* [flake8](http://flake8.pycqa.org)
* [pydocstyle](https://github.com/PyCQA/pydocstyle)
Please check their usages.