From d0ca4b6116585621a2d747317200aa6973758a35 Mon Sep 17 00:00:00 2001 From: Raphael Ackermann Date: Sat, 22 Aug 2009 21:45:34 +0000 Subject: [PATCH] fix typo svn: r13105 --- docs/README.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.txt b/docs/README.txt index daa192a6c..212096213 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -12,7 +12,7 @@ Once installed, go to the docs directory, and do: Which will produce the html output in docs/_build/html -Documention Guidelines +Documentation Guidelines ======================= Doc strings in python files should be written in reStructured text: http://docutils.sourceforge.net/docs/user/rst/quickref.html @@ -58,7 +58,7 @@ the order). check that arg2 is non zero. """ -For a class, use :cvar variable: for class variaable, :ivar variable: for instance class +For a class, use :cvar variable: for class variable, :ivar variable: for instance class variable, .. attribute:: attribute: for attributes, .... See http://sphinx.pocoo.org/markup/desc.html and http://sphinx.pocoo.org/markup/inline.html