[Numpy-discussion] NA_getType needs to be documented

Todd Miller jmiller at stsci.edu
Mon Oct 27 08:04:27 CST 2003


There's a mix of "interface" and "implementation" in libnumarray since
the API jump table mechanism is the only kind of inter-module linkage
used.  Since some of the functions in libnumarray are just there because
they needed to be shared within the implementation, not exported as
public interface, "everything" is never going to be documented. 
However,  specific holes that people point out certainly can be.  I'll
document this one.

Regards,
Todd

On Thu, 2003-10-23 at 20:48, Edward C. Jones wrote:
> "NA_getType" needs to be documented. The following is useful:
> 
>      if (!PyArg_ParseTuple(args, "O", &type))
>          return NULL;
> 
>      temptype = NA_getType(type);
>      if (temptype == NULL) return NULL;
>      typeno = NA_typeObjectToTypeNo(temptype);
>      Py_DECREF(temptype);
>      if (typeno < 0) {
>          PyErr_Format(PyExc_RuntimeError,
>                   "_numarray_init: can't get typeno for type");
>          return NULL;
>      }
> 
> Do other functions in "libnumarraymodule.c" need to be documented?
> 
> 
> 
> -------------------------------------------------------
> This SF.net email is sponsored by: The SF.net Donation Program.
> Do you like what SourceForge.net is doing for the Open
> Source Community?  Make a contribution, and help us add new
> features and functionality. Click here: http://sourceforge.net/donate/
> _______________________________________________
> Numpy-discussion mailing list
> Numpy-discussion at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/numpy-discussion
-- 
Todd Miller 			
Space Telescope Science Institute
3700 San Martin Drive
Baltimore MD, 21030
(410) 338 - 4576





More information about the Numpy-discussion mailing list