docs: add doc-strings for the doc-fields in ContractType (#130)

ApeWorX · Jul 10, 2024 · 1a6ef43 · 1a6ef43
1 parent d239cb8
commit 1a6ef43
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/ethpm_types/contract_type.py b/ethpm_types/contract_type.py
@@ -298,7 +298,16 @@ class ContractType(BaseModel):
     """
 
     userdoc: Optional[dict] = None
+    """
+    Documentation for the end-user, generated from NatSpecs
+    found in the contract source file.
+    """
+
     devdoc: Optional[dict] = None
+    """
+    Documentation for the contract maintainers, generated from NatSpecs
+    found in the contract source file.
+    """
 
     def __repr__(self) -> str:
         repr_id = self.__class__.__name__