[Getdata-commits] SF.net SVN: getdata:[509] trunk/getdata/bindings/python

[<ket...@us...>]

Revision: 509
          http://getdata.svn.sourceforge.net/getdata/?rev=509&view=rev
Author:   ketiltrout
Date:     2011-03-05 04:08:48 +0000 (Sat, 05 Mar 2011)

Log Message:
-----------
Doc fixes.

Modified Paths:
--------------
    trunk/getdata/bindings/python/pydirfile.c
    trunk/getdata/bindings/python/pyentry.c
    trunk/getdata/bindings/python/pygetdata.c

Modified: trunk/getdata/bindings/python/pydirfile.c
===================================================================
--- trunk/getdata/bindings/python/pydirfile.c	2011-03-02 04:36:15 UTC (rev 508)
+++ trunk/getdata/bindings/python/pydirfile.c	2011-03-05 04:08:48 UTC (rev 509)
@@ -2471,8 +2471,8 @@
     "put_carray(field_code, data [, start])\n\n"
       "Store the data in the list or NumPy array 'data' in the CARRAY given\n"
       "by 'field_code'.  If a list is provided, all entries must be of the\n"
-      "same type.  The parameter 'start' indicates where the first sample in\n"
-      "which the data will be stored.  Zero is assumed if not given.\n"
+      "same type.  The parameter 'start' indicates where the first sample\n"
+      "in which the data will be stored.  Zero is assumed if not given.\n"
       "See gd_put_carray_slice(3)."
   },
   {"put_constant", (PyCFunction)gdpy_dirfile_putconstant,
@@ -2561,12 +2561,18 @@
 "providing the same information as the gd_pdata_t structure in the C API.\n"\
 "The second object is the 'extra' object passed to this constructor, and\n"\
 "may be any object desired by the caller.  If no extra parameter was\n"\
-"specified, this will be None.  The sehandler should return one of the\n"\
-"pygetdata.SYNTAX_* symbols.\n\n"\
+/* ---------------------------------------------------------------------| */\
+"specified, this will be None.  The sehandler should return either:\n\n"\
+" * an integer, one of the pygetdata.SYNTAX_... symbols; or\n"\
+" * a string containing the corrected line, and pygetdata.SYNTAX_RESCAN\n"\
+"   is assumed; or\n"\
+" * a tuple consisting of an integer, one of the pygetdata.SYNTAX_...\n"\
+"   symbols, and then, optionally, a string containing the corrected\n"\
+"   line.\n"\
+"\n"\
 "The dirfile will be automatically closed when garbage collection is run\n"\
 "on the object.  In general, however, an explicit call to close() or\n"\
 "discard() is preferable on a writeable dirfile, since the implicit close\n"\
-/* ---------------------------------------------------------------------| */\
 "performed on the dirfile when the object is deleted silently discards\n"\
 "any errors encountered when the dirfile is flushed to disc.  After\n"\
 "explicitly calling close() or discard(), the dirfile will be\n"\

Modified: trunk/getdata/bindings/python/pyentry.c
===================================================================
--- trunk/getdata/bindings/python/pyentry.c	2011-03-02 04:36:15 UTC (rev 508)
+++ trunk/getdata/bindings/python/pyentry.c	2011-03-05 04:08:48 UTC (rev 509)
@@ -1988,8 +1988,8 @@
 "                    or a CONST field code specifying the same.\n\n"\
 "  RECIP:        (in_field, dividend)\n"\
 "    'in_field':   a string containing the input field code.\n"\
-"    'dividend':   a number or CONST field code specifying the dividend of\n"\
-"                    the RECIP.\n\n"\
+"    'dividend':   a number or CONST field code specifying the dividend\n"\
+"                    of the RECIP.\n\n"\
 "If a dictionary, the keys of 'parameters' should be the names of the\n"\
 "tuple parameters listed above (ie. 'type' and 'spf' for a RAW field),\n"\
 "and the values the same as their tuple counterparts.\n\n"\

Modified: trunk/getdata/bindings/python/pygetdata.c
===================================================================
--- trunk/getdata/bindings/python/pygetdata.c	2011-03-02 04:36:15 UTC (rev 508)
+++ trunk/getdata/bindings/python/pygetdata.c	2011-03-05 04:08:48 UTC (rev 509)
@@ -545,13 +545,13 @@
       "not\npresent, vector data will be returned as Python lists.  Vector "
       "data passed\nto pygetdata may either be a Python list or a NumPy array."
       "\n\n"
-      "The input data type argument to bindings for functions such as "
-      "gd_putdata(3),\nwhich is required in the C API, are typically optional, "
-      "as pygetdata can\ndetermine the input data type by itself, and convert "
-      "it to an appropriate\ntype for the C API.  If the data type is supplied,"
-      " pygetdata will coerce the\ninput data to the specified C type as best "
-      "it can.  For gd_getdata(3) and\nsimilar, the C API types are converted "
-      "to Python types as follows:\n\n"
+      "The input data type argument to bindings for functions such as\n"
+      "gd_putdata(3), which is required in the C API, are typically optional,\n"
+      "as pygetdata can determine the input data type by itself, and convert "
+      "it to\nan appropriate type for the C API.  If the data type is supplied,"
+      " pygetdata\nwill coerce the input data to the specified C type as best "
+      "it can.  For\ngd_getdata(3) and similar, the C API types are converted "
+      "to Python types as\nfollows:\n\n"
       "  o int     -- UINT8, INT8, UINT16, INT16, INT32\n"
       "  o long    -- UINT32, UINT64, INT64\n"
       "  o float   -- FLOAT32, FLOAT64\n"


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.