mirror of
https://github.com/kennethreitz/python-guide.git
synced 2026-06-05 23:00:18 +00:00
massive refactor
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
Documenting Your Code
|
||||
=====================
|
||||
|
||||
Documenting your code is extremely important. It is debatebly even
|
||||
more important than testing.
|
||||
|
||||
|
||||
The Basics
|
||||
::::::::::
|
||||
|
||||
|
||||
Code Comments
|
||||
-------------
|
||||
|
||||
|
||||
|
||||
Doc Strings
|
||||
-----------
|
||||
|
||||
|
||||
|
||||
Sphinx
|
||||
::::::
|
||||
|
||||
|
||||
|
||||
Other Tools
|
||||
:::::::::::
|
||||
|
||||
that old thing
|
||||
--------------
|
||||
|
||||
pocco / docco / shocco
|
||||
----------------------
|
||||
|
||||
Ronn
|
||||
----
|
||||
@@ -0,0 +1,22 @@
|
||||
Structuring Your Project
|
||||
========================
|
||||
|
||||
Structuring your project properly is extremely important.
|
||||
|
||||
|
||||
Structure is Key
|
||||
----------------
|
||||
|
||||
|
||||
|
||||
Vendorizing Dependencies
|
||||
------------------------
|
||||
|
||||
|
||||
|
||||
Runners
|
||||
-------
|
||||
|
||||
|
||||
Further Reading
|
||||
---------------
|
||||
@@ -0,0 +1,14 @@
|
||||
Code Style
|
||||
==========
|
||||
|
||||
|
||||
Idioms
|
||||
::::::
|
||||
|
||||
|
||||
Zen of Python
|
||||
-------------
|
||||
|
||||
|
||||
PEP-8
|
||||
-----
|
||||
@@ -0,0 +1,57 @@
|
||||
Testing Your Code
|
||||
=====================
|
||||
|
||||
Testing your code is very important.
|
||||
|
||||
|
||||
The Basics
|
||||
::::::::::
|
||||
|
||||
|
||||
Unittest
|
||||
--------
|
||||
|
||||
|
||||
|
||||
Doc Strings
|
||||
-----------
|
||||
|
||||
|
||||
|
||||
|
||||
Tools
|
||||
:::::
|
||||
|
||||
|
||||
Doctest
|
||||
-------
|
||||
|
||||
|
||||
Nose
|
||||
----
|
||||
|
||||
|
||||
::
|
||||
|
||||
$ pip install tox
|
||||
|
||||
|
||||
|
||||
Unittest2
|
||||
---------
|
||||
|
||||
A backport of Python 2.7's
|
||||
|
||||
|
||||
::
|
||||
|
||||
$ pip install tox
|
||||
|
||||
|
||||
tox
|
||||
---
|
||||
|
||||
|
||||
::
|
||||
|
||||
$ pip install tox
|
||||
Reference in New Issue
Block a user