[pypy-svn] pypy documentation-cleanup: (lac, cfbolz): those need work, but we want to keep them

cfbolz commits-noreply at bitbucket.org
Mon Apr 25 12:01:03 CEST 2011


Author: Carl Friedrich Bolz <cfbolz at gmx.de>
Branch: documentation-cleanup
Changeset: r43560:a7386abcdfc0
Date: 2011-04-25 11:55 +0200
http://bitbucket.org/pypy/pypy/changeset/a7386abcdfc0/

Log:	(lac, cfbolz): those need work, but we want to keep them

diff --git a/pypy/doc/distribution.rst b/pypy/doc/distribution.rst
--- a/pypy/doc/distribution.rst
+++ b/pypy/doc/distribution.rst
@@ -1,10 +1,8 @@
-.. include:: crufty.rst
+.. include:: needswork.rst
 
-     .. ^^ Incomplete,  superceded elsewhere
-
-========================
-lib/distributed features
-========================
+=============================
+lib_pypy/distributed features
+=============================
 
 The 'distributed' library is an attempt to provide transparent, lazy
 access to remote objects. This is accomplished using

diff --git a/pypy/doc/how-to-release.rst b/pypy/doc/how-to-release.rst
--- a/pypy/doc/how-to-release.rst
+++ b/pypy/doc/how-to-release.rst
@@ -1,4 +1,6 @@
-.. include:: crufty.rst
+.. include:: needswork.rst
+
+.. needs work, it talks about svn. also, it is not really user documentation
 
 Making a PyPy Release
 =======================

diff --git a/pypy/doc/glossary.rst b/pypy/doc/glossary.rst
--- a/pypy/doc/glossary.rst
+++ b/pypy/doc/glossary.rst
@@ -1,3 +1,5 @@
+.. include:: needswork.rst
+
 .. _glossary:
 
 ********
@@ -12,12 +14,6 @@
 
 .. glossary::
 
-**abstract interpretation**
-    The technique of interpreting the bytecode of a user program with
-    an interpreter that handles abstract objects instead of concrete ones.
-    It can be used to check the bytecode or see what it does, without
-    actually executing it with concrete values.  See Theory_.
-
 .. _annotator:
 
 **annotator**
@@ -107,11 +103,6 @@
 
 .. _`object space`:
 
-**multimethod**
-   A callable object that invokes a different Python function based
-   on the type of all its arguments (instead of just the class of the
-   first argument, as with normal methods).  See Theory_.
-
 **object space**
    The `object space <objspace.html>`__ (often abbreviated to
    "objspace") creates all objects and knows how to perform operations
@@ -242,6 +233,5 @@
 .. _Python: http://www.python.org
 .. _`RPython Typer`: rtyper.html
 .. _`subsystem implementing the Python language`: architecture.html#standard-interpreter
-.. _Theory: theory.html
 
 .. include:: _ref.rst

diff --git a/pypy/doc/needswork.rst b/pypy/doc/needswork.rst
new file mode 100644
--- /dev/null
+++ b/pypy/doc/needswork.rst
@@ -0,0 +1,3 @@
+.. warning::
+
+   This documentation needs work (as discussed during the Gothenburg sprint in 2011)


More information about the Pypy-commit mailing list