Merge pull request #126 from azmeuk/docs

Developper documentation improvements
zopefoundation · Mar 16, 2020 · 7d439db · 7d439db
2 parents 87599a7 + 5e70103
commit 7d439db
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/BTrees/Development.txt → docs/development.rst b/BTrees/Development.txt → docs/development.rst
@@ -313,8 +313,8 @@ invariant still holds, with ``lo==i`` and ``hi==lo+1==i+1``::
 so ``i`` is again the correct answer.
 
 
-Optimization points:
---------------------
+Optimization points
+-------------------
 
 + Division by 2 is done via shift rather via "/2".  These are signed ints, and
   almost all C compilers treat signed int division as truncating, and shifting
@@ -405,8 +405,8 @@ correct to exit with ``_cmp`` non-zero, and ``i==lo`` is again the index at
 which ``k`` belongs.
 
 
-Optimization points:
---------------------
+Optimization points
+-------------------
 
 + As for ``BTREE_SEARCH``, shifting of signed ints is cheaper than division.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ Contents:
 
    overview
    api
+   development
 
 ====================
  Indices and tables