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
|
||||
----
|
||||
Reference in New Issue
Block a user