Merge pull request #138 from davesque/doc-updates

Update docs for release and new custom stream class feature
ethereum · Dec 10, 2019 · 678d499 · 678d499
2 parents 2f8a0b3 + e9258f5
commit 678d499
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/docs/codecs.rst b/docs/codecs.rst
@@ -91,3 +91,28 @@ capability coupled with the use of a custom codec:
         default_codec.encode_single('address', '0x' + 'ff' * 20) ==
         b'\x00' * 12 + b'\xff' * 20
     )
+
+.. _custom_stream_class:
+
+Using a Custom Stream Class
+---------------------------
+
+If a user wishes to customize the behavior of the internal stream class used
+for decoding, they can do the following:
+
+.. testcode:: custom-stream-class
+
+    from eth_abi.codec import ABIEncoder, ABIDecoder
+    from eth_abi.registry import registry
+
+    class MyStream:
+        # Custom behavior...
+        pass
+
+    class MyDecoder(ABIDecoder):
+        stream_class = MyStream
+
+    class MyCodec(ABIEncoder, MyDecoder):
+        pass
+
+    codec = MyCodec(registry)
diff --git a/docs/releases.rst b/docs/releases.rst
@@ -1,6 +1,18 @@
 Release Notes
 =============
 
+v2.1.0
+------
+
+- Added support for "byte" alias for "bytes1" type.
+- Added support for custom stream class in :class:`~eth_abi.codec.ABIDecoder`.
+  See :ref:`custom_stream_class`.
+
+v2.0.0
+------
+
+- Includes all changes from v2.0.0 beta and alpha versions.
+
 v2.0.0-beta.9
 -------------