From d1c740cf51aacd08c10f18582b66a4856f131f55 Mon Sep 17 00:00:00 2001 From: Robert Kern Date: Tue, 22 Jan 2008 06:31:01 +0000 Subject: Set __docformat__ such that epydoc knows it's looking at reST instead of epytext. --- numpy/doc/html/example-module.html | 128 ++++++++++++++++++------------------- 1 file changed, 64 insertions(+), 64 deletions(-) (limited to 'numpy/doc/html/example-module.html') diff --git a/numpy/doc/html/example-module.html b/numpy/doc/html/example-module.html index 7a9fdfd5a..f08370632 100644 --- a/numpy/doc/html/example-module.html +++ b/numpy/doc/html/example-module.html @@ -56,12 +56,12 @@

Module example

source code

This is the docstring for the example.py module. Modules names should - have short, all-lowercase names. The module name may have underscores if - this improves readability.

-

Every module should have a docstring at the very top of the file. The - module's docstring may extend over multiple lines. If your docstring - does extend over multiple lines, the closing three quotation marks must - be on a line by itself, preferably preceeded by a blank line.

+have short, all-lowercase names. The module name may have underscores if +this improves readability.

+

Every module should have a docstring at the very top of the file. The +module's docstring may extend over multiple lines. If your docstring does +extend over multiple lines, the closing three quotation marks must be on +a line by itself, preferably preceeded by a blank line.

@@ -168,61 +168,61 @@ - 
-One-line summary or signature.
-
-Several sentences providing an extended description. You can put
-text in mono-spaced type like so: ``var``.
-
-Parameters
-----------
-var1 : array_like
-    Array_like means all those objects -- lists, nested lists, etc. --
-    that can be converted to an array.
-var2 : integer
-    Write out the full type
-long_variable_name : {'hi', 'ho'}, optional
-    Choices in brackets, default first when optional.
-
-Returns
--------
-named : type
-    Explanation
-list
-    Explanation
-of
-    Explanation
-outputs
-    even more explaining
-
-Other Parameters
-----------------
-only_seldom_used_keywords : type
-    Explanation
-common_parametrs_listed_above : type
-    Explanation
-
-See Also
---------    
-otherfunc : relationship (optional)
-newfunc : relationship (optional)
-
-Notes
------
-Notes about the implementation algorithm (if needed).
-
-This can have multiple paragraphs as can all sections.
-
-Examples
---------
-
-examples in doctest format
-
->>> a=[1,2,3]
->>> [x + 3 for x in a]
-[4, 5, 6]
-
-
+

One-line summary or signature.

+

Several sentences providing an extended description. You can put +text in mono-spaced type like so: var.

+
+

Parameters

+
+
var1 : array_like
+
Array_like means all those objects -- lists, nested lists, etc. -- +that can be converted to an array.
+
var2 : integer
+
Write out the full type
+
long_variable_name : {'hi', 'ho'}, optional
+
Choices in brackets, default first when optional.
+
+
+
+

Returns

+
+
named : type
+
Explanation
+
list
+
Explanation
+
of
+
Explanation
+
outputs
+
even more explaining
+
+
+
+

Other Parameters

+
+
only_seldom_used_keywords : type
+
Explanation
+
common_parametrs_listed_above : type
+
Explanation
+
+
+
+

See Also

+

otherfunc : relationship (optional) +newfunc : relationship (optional)

+
+
+

Notes

+

Notes about the implementation algorithm (if needed).

+

This can have multiple paragraphs as can all sections.

+
+
+

Examples

+

examples in doctest format

+
+>>> a=[1,2,3]
+>>> [x + 3 for x in a]
+[4, 5, 6]
+
@@ -242,7 +242,7 @@ examples in doctest format

Do nothing.

-

I never saw a purple cow.

+

I never saw a purple cow.

@@ -262,7 +262,7 @@ examples in doctest format

Do nothing.

-

I never hope to see one.

+

I never hope to see one.

@@ -294,7 +294,7 @@ examples in doctest format
- Generated by Epydoc 3.0beta1 on Fri Dec 28 00:50:17 2007 + Generated by Epydoc 3.0beta1 on Tue Jan 22 00:26:36 2008