[Scipy-svn] r3926 - trunk/scipy/ndimage

scipy-svn@scip... scipy-svn@scip...
Tue Feb 12 17:31:56 CST 2008


Author: chris.burns
Date: 2008-02-12 17:31:54 -0600 (Tue, 12 Feb 2008)
New Revision: 3926

Modified:
   trunk/scipy/ndimage/_segmenter.py
Log:
Add stub for documenting C extension functions.

Modified: trunk/scipy/ndimage/_segmenter.py
===================================================================
--- trunk/scipy/ndimage/_segmenter.py	2008-02-12 21:32:39 UTC (rev 3925)
+++ trunk/scipy/ndimage/_segmenter.py	2008-02-12 23:31:54 UTC (rev 3926)
@@ -10,6 +10,14 @@
 Use this module minimally, if at all, until it this warning is removed."
 warnings.warn(_msg, UserWarning)
 
+# TODO:  Add docstrings for public functions in extension code.
+# Add docstrings to extension code.
+#from numpy.lib import add_newdoc
+#add_newdoc('scipy.ndimage._segment', 'canny_edges',
+#    """Canney edge detector.
+#    """)
+
+
 # WARNING: _objstruct data structure mirrors a corresponding data structure
 # in ndImage_Segmenter_structs.h that is built into the _segment.so library.
 # These structs must match!  



More information about the Scipy-svn mailing list