Doc updates (#297)

* Updated ZODB info to provide link to python example (current version didn't give any python code) * Noted that pickling is currently broken and provided a link --------- Co-authored-by: Mike Taves <[email protected]>
Toblerity · Jan 18, 2024 · afbc496 · afbc496
1 parent d816ef2
commit afbc496
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/source/performance.txt b/docs/source/performance.txt
@@ -38,6 +38,12 @@ Override :py:data:`~rtree.index.Index.dumps` to use the highest pickle protocol
     ...         return cPickle.dumps(obj, -1)
     >>> r = FastRtree()
 
+.. topic:: Update from January 2024
+
+   Pickling is currently broken and awaiting a pull requst to fix it.
+   For more information, see the `pull request on GitHub`_.
+
+.. _pull request on GitHub: https://github.com/Toblerity/rtree/pull/197
 
 Use objects='raw'
 ...............................................................................

diff --git a/docs/source/tutorial.txt b/docs/source/tutorial.txt
@@ -201,7 +201,11 @@ ZODB and Custom Storages
 ..............................................................................
 
 https://mail.zope.org/pipermail/zodb-dev/2010-June/013491.html contains a custom
-storage backend for `ZODB`_
+storage backend for `ZODB`_ and you can find example python code `here`_. Note
+that the code was written in 2011, hasn't been updated and was only an alpha
+version.
+
+.. _here: https://github.com/Toblerity/zope.index.rtree
 
 .. _ZODB: http://www.zodb.org/