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

[mwh at codespeak.net]

Author: mwh
Date: Fri Mar 23 17:09:55 2007
New Revision: 41198

Modified:
   pypy/dist/pypy/doc/object-optimizations.txt
Log:
add a table of contents, a few content tweaks


Modified: pypy/dist/pypy/doc/object-optimizations.txt
==============================================================================
--- pypy/dist/pypy/doc/object-optimizations.txt	(original)
+++ pypy/dist/pypy/doc/object-optimizations.txt	Fri Mar 23 17:09:55 2007
@@ -2,6 +2,11 @@
 Alternative object implementations in the PyPy standard interpreter
 ===================================================================
 
+.. contents:: Contents
+
+Introduction
+============
+
 One of the advantages of the PyPy standard interpreter (compared to CPython) is
 that we can provide several implementations of the same object (e.g. for lists
 and strings) without the user noticing any difference. This makes it easy to
@@ -17,7 +22,6 @@
 since you have to know only a rather small part of PyPy to do them. And they are
 fun too!
 
-
 String optimizations
 ====================
 
@@ -50,7 +54,6 @@
 
 You can enable this feature with the :config:`objspace.std.withstrslice` option.
 
-
 Ropes
 -----
 
@@ -85,10 +88,10 @@
 caching small integers
 ----------------------
 
-Similar to what CPython does it is possible to enable caching of small integer
-objects to not have to allocate all the time when doing simple arithmetic. Every
-time a new integer object is created it is checked whether the integer is small
-enough to be retrieved from the cache.
+Similar to CPython, it is possible to enable caching of small integer objects to
+not have to allocate all the time when doing simple arithmetic. Every time a new
+integer object is created it is checked whether the integer is small enough to
+be retrieved from the cache.
 
 You can enable this feature with the :config:`objspace.std.withsmallint` option.
 
@@ -111,18 +114,18 @@
 
 Multi-dicts are a special implementation of dictionaries.  It became clear that
 it is very useful to *change* the internal representation of an object during
-its lifetime.  Multi-Dicts are a general way to do that for dictionaries: they
+its lifetime.  Multi-dicts are a general way to do that for dictionaries: they
 provide generic support for the switching of internal representations for
 dicts.
 
 If you just enable multi-dicts, special representations for empty dictionaries,
-for string-keyed dictionaries and for small dictionaries are used (as well as a
-general representation that can store arbitrary keys). In addition there are
-more specialized dictionary implementations for various purposes (see below).
+for string-keyed dictionaries. In addition there are more specialized dictionary
+implementations for various purposes (see below).
 
 You can enable this feature with the :config:`objspace.std.withmultidict`
 option.
 
+.. XXX chunked dicts, small dicts
 
 sharing dicts
 -------------
@@ -144,7 +147,6 @@
 You can enable this feature with the :config:`objspace.std.withsharingdict`
 option.
 
-
 builtin-shadowing
 -----------------
 
@@ -257,3 +259,5 @@
 
 You can enable this feature with the :config:`objspace.std.withmethodcache`
 option.
+
+.. CALL_METHOD?