docs: add convert example

ApeWorX · Aug 23, 2024 · 584b602 · 584b602
1 parent 078b8f2
commit 584b602
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/methoddocs/api.md b/docs/methoddocs/api.md
@@ -40,6 +40,7 @@
 .. automodule:: ape.api.convert
     :members:
     :show-inheritance:
+    :special-members:
 ```
 
 ## Explorers

diff --git a/src/ape/api/convert.py b/src/ape/api/convert.py
@@ -25,4 +25,22 @@ def convert(self, value: Any) -> ConvertedType:
         Convert the given value to the type specified as the generic for this class.
         Implementations of this API must throw a :class:`~ape.exceptions.ConversionError`
         when the item fails to convert properly.
+
+        Usage example::
+
+            from ape import convert
+            from ape.types import AddressType
+
+            convert("1 gwei", int)
+            # 1000000000
+
+            convert("1 ETH", int)
+            # 1000000000000000000
+
+            convert("283Af0B28c62C092C9727F1Ee09c02CA627EB7F5", bytes)
+            # HexBytes('0x283af0b28c62c092c9727f1ee09c02ca627eb7f5')
+
+            convert("vitalik.eth", AddressType)
+            # '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
+
         """