kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #37 from darius/patch-1

Browse Source 
Fix indent in code examples.
This commit is contained in:
Kenneth Reitz
2011-12-29 21:05:32 -08:00
parent f2a0af5541 1758ba7434
commit 31493c7f43
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+11 -11
View File
@@ -39,23 +39,23 @@ PEP 257 is the primary reference for docstrings. (http://www.python.org/dev/peps
|One-line docstrings: :: |One-line docstrings: ::
def kos_root(): def kos_root():
"""Return the pathname of the KOS root directory.""" """Return the pathname of the KOS root directory."""
global _kos_root global _kos_root
if _kos_root: return _kos_root if _kos_root: return _kos_root
... ...
Multi-line docstrings: :: Multi-line docstrings: ::
def complex(real=0.0, imag=0.0): def complex(real=0.0, imag=0.0):
"""Form a complex number. """Form a complex number.
Keyword arguments: Keyword arguments:
real -- the real part (default 0.0) real -- the real part (default 0.0)
imag -- the imaginary part (default 0.0) imag -- the imaginary part (default 0.0)
""" """
if imag == 0.0 and real == 0.0: return complex_zero if imag == 0.0 and real == 0.0: return complex_zero
... ...
Sphinx Sphinx
------ ------