Mercurial > pymonkey
diff docs/src/pymonkey.txt @ 53:2055d853b995
Added docs for pymonkey.Object.
author | Atul Varma <varmaa@toolness.com> |
---|---|
date | Fri, 10 Jul 2009 17:07:26 -0700 |
parents | fabd3f2271fa |
children | 234fca1c4b86 |
line wrap: on
line diff
--- a/docs/src/pymonkey.txt Wed Jul 08 18:45:38 2009 -0700 +++ b/docs/src/pymonkey.txt Fri Jul 10 17:07:26 2009 -0700 @@ -16,6 +16,18 @@ This is the type of any SpiderMonkey-related errors thrown by this module. +.. class:: Object + + This is the type of JavaScript objects. Such objects can only be + created via Pymonkey calls like :meth:`Context.new_object()` or + through the execution of JS code, but this type object can be used + with Python's built-in :func:`isinstance()` to verify that an + object is a JS object, like so: + + >>> obj = pymonkey.Runtime().new_context().new_object() + >>> isinstance(obj, pymonkey.Object) + True + .. class:: Context This is the type of JavaScript context objects. Contexts can only @@ -29,9 +41,8 @@ .. class:: Runtime() - Creates a new JavaScript runtime. JS objects created by the - runtime may interact with other JS objects of the runtime, but - they can't interact with objects from other runtimes. + Creates a new JavaScript runtime. JS objects created by the runtime + may only interact with other JS objects of the same runtime. .. method:: new_context()