diff docs/rendered/_sources/pymonkey.txt @ 79:228a56e7e793

Added docs for context.get_object_private().
author Atul Varma <varmaa@toolness.com>
date Fri, 07 Aug 2009 18:56:32 -0700
parents c48b393f6461
children 4945e4073110
line wrap: on
line diff
--- a/docs/rendered/_sources/pymonkey.txt	Fri Aug 07 11:21:21 2009 -0700
+++ b/docs/rendered/_sources/pymonkey.txt	Fri Aug 07 18:56:32 2009 -0700
@@ -64,9 +64,21 @@
 
       Returns the :class:`Runtime` that the context belongs to.
 
-   .. method:: new_object()
+   .. method:: new_object([private_obj])
+
+      Creates a new :class:`Object` instance and returns
+      it. ``private_obj`` is any Python object that is privately
+      stored within the new JS object; it can be retrieved using
+      :func:`.get_object_private()`.
 
-      Creates a new :class:`Object` instance and returns it.
+   .. method:: get_object_private(object)
+
+      Returns the ``private_obj`` passed to :func:`.new_object()`
+      when `object` was first created. If it doesn't exist, ``None``
+      is returned.
+
+      This functionality is useful if you want to represent Python
+      objects in JS-land.
 
    .. method:: init_standard_classes(object)