Merge pull request #165 from AlbertoCentonze/master

docs: added alias function description
vyperlang · Feb 16, 2024 · 2279ec7 · 2279ec7
2 parents ef3f909 + 189f14d
commit 2279ec7
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -403,6 +403,13 @@ Low-Level Functionality
 
         The global py-evm chain instance.
 
+    .. method:: alias(address: str, name: str) -> None
+
+        Associates an alias with an address. This is useful to make the address more human-readable in tracebacks.
+
+        :param address: The address to alias.
+        :param name: The alias to use for the address.
+
     .. method:: generate_address(alias: str | None = None) -> str
 
         Generate an address and optionally alias it.