[pypy-commit] pypy improve-docs: explain why unwrap is so strongly discouraged

[numerodix]

Author: Martin Matusiak <numerodix at gmail.com>
Branch: improve-docs
Changeset: r72951:71a3763555f6
Date: 2014-08-21 19:41 +0200
http://bitbucket.org/pypy/pypy/changeset/71a3763555f6/

Log:	explain why unwrap is so strongly discouraged

diff --git a/pypy/doc/objspace.rst b/pypy/doc/objspace.rst
--- a/pypy/doc/objspace.rst
+++ b/pypy/doc/objspace.rst
@@ -232,8 +232,10 @@
 
 .. py:function:: unwrap(w_x)
 
-   Returns the interpreter-level equivalent of :py:obj:`w_x` -- use this **ONLY** for
-   testing! In most circumstances you should use the functions described below instead.
+   Returns the interpreter-level equivalent of :py:obj:`w_x` -- use this
+   **ONLY** for testing, because this method is not RPython and thus cannot be
+   translated! In most circumstances you should use the functions described
+   below instead.
 
 .. py:function:: is_true(w_x)