[pypy-svn] r41120 - pypy/dist/pypy/doc

[cfbolz at codespeak.net]

Author: cfbolz
Date: Thu Mar 22 20:17:23 2007
New Revision: 41120

Modified:
   pypy/dist/pypy/doc/__pypy__-module.txt
   pypy/dist/pypy/doc/objspace-proxies.txt
Log:
don't duplicate the interface section, point to it (still mention the names,
for easier greppability).


Modified: pypy/dist/pypy/doc/__pypy__-module.txt
==============================================================================
--- pypy/dist/pypy/doc/__pypy__-module.txt	(original)
+++ pypy/dist/pypy/doc/__pypy__-module.txt	Thu Mar 22 20:17:23 2007
@@ -37,36 +37,26 @@
 .. _`thunk object space docs`: objspace-proxies.html#thunk
 
 Taint Object Space Functionality
-===============================
+================================
 
 When the taint object space is used (choose with :config:`objspace.name`),
-the following objects are put into ``__pypy__``:
-
- - ``taint(obj)``: Return a tainted version of the argument.
-
- - ``is_tainted(obj)``: Return whether the argument is tainted.
-
- - ``untaint(expectedtype, tainted_obj)``: Untaint untainted_obj and return it.
-   If the result is not of expectedtype, raise a type error.
-
- - ``taint_atomic(callable)``: decorator to make a callable "taint-atomic": if
-   the function is called with tainted arguments, those are untainted. The
-   result of the function is tainted again.  All exceptions that the callable
-   raises are turned into taint bombs.
-
- - ``_taint_debug(debug_level)``: Set the debug level. If the debug level is
-   greater than 0, the creation of taint bombs will print debug information. For
-   debugging purposes only!
+the following names are put into ``__pypy__``:
 
- - ``_taint_look(obj)``: Print some info about the taintedness of an object. For
-   debugging purposes only!
+ - ``taint``
+ - ``is_tainted``
+ - ``untaint``
+ - ``taint_atomic``
+ - ``_taint_debug``
+ - ``_taint_look``
+ - ``TaintError``
 
- - ``TaintError``: Exception that is raised when an operation revealing
-   information on a tainted object is performed.
+Those are all described in the `interface section`_ of the taint object space
+docs.
 
-For explanations and examples see the `taint object space docs`_.
+For more detailed explanations and examples see the `taint object space docs`_.
 
 .. _`taint object space docs`: objspace-proxies.html#taint
+.. _`interface section`: objspace-proxies.html#taint-interface
 
 Transparent Proxy Functionality
 ===============================

Modified: pypy/dist/pypy/doc/objspace-proxies.txt
==============================================================================
--- pypy/dist/pypy/doc/objspace-proxies.txt	(original)
+++ pypy/dist/pypy/doc/objspace-proxies.txt	Thu Mar 22 20:17:23 2007
@@ -370,6 +370,8 @@
 arguments.
 
 
+.. _`taint-interface`:
+
 Interface
 ---------