Revision: 635
http://rpy.svn.sourceforge.net/rpy/?rev=635&view=rev
Author: lgautier
Date: 2008-08-18 07:22:54 +0000 (Mon, 18 Aug 2008)
Log Message:
-----------
Sphinx-style docstrings added
Modified Paths:
--------------
branches/rpy_nextgen/rpy/rinterface/rinterface.c
Modified: branches/rpy_nextgen/rpy/rinterface/rinterface.c
===================================================================
--- branches/rpy_nextgen/rpy/rinterface/rinterface.c 2008-08-18 07:22:09 UTC
(rev 634)
+++ branches/rpy_nextgen/rpy/rinterface/rinterface.c 2008-08-18 07:22:54 UTC
(rev 635)
@@ -539,10 +539,11 @@
return res;
}
PyDoc_STRVAR(Sexp_do_slot_doc,
-"\n\
-Returns the attribute/slot for an R object.\n\
-The name of the slot (a string) is the only parameter for\
- the method.\n");
+ "Returns the attribute/slot for an R object.\n"
+ " The name of the slot (a string) is the only parameter for\n"
+ "the method.\n"
+ ":param name: string\n"
+ ":rtype: instance of type or subtype
:class:`rpy2.rinterface.Sexp`");
static PyObject*
Sexp_named(PyObject *self)
@@ -1087,11 +1088,13 @@
}
PyDoc_STRVAR(SexpClosure_rcall_doc,
-"Call using the items of the object passed as Python \n\
-argument to build the list of parameters passed to the \n\
-R function.");
+ "Call using the items of the object passed as Python \n"
+ "argument to build the list of parameters passed to the \n"
+ "R function.\n\n"
+ ":param args: tuple of two-elements items"
+ " or class::`rlike.container.ArgsDict`\n\n"
+ ":rtype: instance of type or subtype :class:`rinterface.Sexp`\n");
-
static PySexpObject*
Sexp_closureEnv(PyObject *self)
{
@@ -1112,8 +1115,10 @@
}
PyDoc_STRVAR(Sexp_closureEnv_doc,
"\n\
-Returns the environment the object is defined in.\
-This corresponds to the C-level function CLOENV(SEXP).");
+Returns the environment the object is defined in.\n\
+This corresponds to the C-level function CLOENV(SEXP).\n\
+\n\
+:rtype: :class:`rinterface.SexpEnvironment`\n");
static PyMethodDef ClosureSexp_methods[] = {
{"closureEnv", (PyCFunction)Sexp_closureEnv, METH_NOARGS,
@@ -1585,10 +1590,11 @@
}
PyDoc_STRVAR(EnvironmentSexp_findVar_doc,
"Find a name/symbol in the environment, following the chain of
enclosing\n"
- " environments until either the topmost environment is reached or
the name\n"
+ "environments until either the topmost environment is reached or
the name\n"
"is found, and returned the associated object. \n"
"The optional parameter `wantFun` indicates whether functions
should be\n"
- "returned or not.");
+ "returned or not.\n"
+ ":rtype: instance of type of subtype
:class:`rpy2.rinterface.Sexp`");
static PyObject*
EnvironmentSexp_frame(PyObject *self)
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
rpy-list mailing list
rpy-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/rpy-list
