docs: add natspec for decimals

curvefi · Dec 14, 2020 · d2bdbb0 · d2bdbb0
1 parent c5d4672
commit d2bdbb0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/contracts/tokens/CurveTokenV3.vy b/contracts/tokens/CurveTokenV3.vy
@@ -48,6 +48,11 @@ def __init__(_name: String[64], _symbol: String[32]):
 @view
 @external
 def decimals() -> uint256:
+    """
+    @notice Get the number of decimals for this token
+    @dev Implemented as a view method to reduce gas costs
+    @return uint256 decimal places
+    """
     return 18