massive refactor

This commit is contained in:
Kenneth Reitz
2011-04-23 16:39:37 -04:00
parent af1cad8ca9
commit 9b8af20caf
18 changed files with 39 additions and 17 deletions
+37
View File
@@ -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
----
+22
View File
@@ -0,0 +1,22 @@
Structuring Your Project
========================
Structuring your project properly is extremely important.
Structure is Key
----------------
Vendorizing Dependencies
------------------------
Runners
-------
Further Reading
---------------
+14
View File
@@ -0,0 +1,14 @@
Code Style
==========
Idioms
::::::
Zen of Python
-------------
PEP-8
-----
+57
View File
@@ -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