diff docs/rendered/_sources/pymonkey.txt @ 90:c41f1d2e8f9d

Added more docs.
author Atul Varma <varmaa@toolness.com>
date Fri, 14 Aug 2009 20:26:40 -0700
parents e9f450d30c0e
children df607254de2d
line wrap: on
line diff
--- a/docs/rendered/_sources/pymonkey.txt	Sun Aug 09 22:54:15 2009 -0700
+++ b/docs/rendered/_sources/pymonkey.txt	Fri Aug 14 20:26:40 2009 -0700
@@ -79,9 +79,21 @@
    .. method:: new_function(callable, name)
 
       Creates a new :class:`Function` instance that wraps the
-      given Python callable.  In JS-land, the callable will
+      given Python callable.  In JS-land, the function will
       have the given name.
 
+      When the function is executed from JavaScript, `callable`
+      will be passed three positional arguments.
+
+      The first argument is a :class:`Context` that represents the
+      JS context which is calling the function.
+
+      The second argument is an :class:`Object` that represents the
+      value of ``this`` for the duration of the call.
+
+      The third argument is a tuple containing the arguments
+      passed to the function.
+
    .. method:: get_object_private(object)
 
       Returns the ``private_obj`` passed to :meth:`new_object()`
@@ -91,8 +103,8 @@
       If `object` was created with :meth:`new_function()`, then this
       method returns the Python callable wrapped by `object`.
 
-      This functionality is useful if you want to represent Python
-      objects in JS-land.
+      This functionality is useful if you want to securely represent
+      Python objects in JS-land.
 
    .. method:: clear_object_private(object)
 
@@ -105,6 +117,25 @@
       `object`. If `object` is later called, an exception will be
       raised.
 
+   .. method:: evaluate_script(globalobj, code, filename, lineno)
+
+      Evaluates the text `code` using `globalobj` as the global
+      object/scope.
+
+      It's assumed that `code` is coming from the file named by `filename`;
+      the first line of `code` is assumed to be line number `lineno` of
+      `filename`. This metadata is very useful for debugging stack traces,
+      exceptions, and so forth.
+
+   .. method:: call_function(thisobj, func, args)
+
+      Calls a JavaScript function.
+
+      `thisobj` is an :class:`Object` that will be used as the value
+      of ``this`` when the function executes, `func` is the
+      :class:`Function` to execute, and `args` is a tuple of arguments
+      to pass to the function.
+
    .. method:: init_standard_classes(object)
 
       Defines the standard JavaScript classes on the given