From 10ec49ddb94d7d20ec99b7c8552d743f9e72b247 Mon Sep 17 00:00:00 2001 From: Christian Parpart Date: Wed, 24 Mar 2021 17:09:42 +0100 Subject: [PATCH] Adds @custom:.... natspec example to the natspec-format documentation. Co-authored-by: Harikrishnan Mulackal --- docs/natspec-format.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/natspec-format.rst b/docs/natspec-format.rst index 0c08fe010..dbbfbc4d9 100644 --- a/docs/natspec-format.rst +++ b/docs/natspec-format.rst @@ -60,12 +60,13 @@ The following example shows a contract and a function using all available tags. .. code:: Solidity // SPDX-License-Identifier: GPL-3.0 - pragma solidity >=0.6.12 <0.9.0; + pragma solidity >=0.8.2 < 0.9.0; /// @title A simulator for trees /// @author Larry A. Gardner /// @notice You can use this contract for only the most basic simulation /// @dev All function calls are currently implemented without side effects + /// @custom:experimental This is an experimental contract. contract Tree { /// @notice Calculate tree age in years, rounded up, for live trees /// @dev The Alexandr N. Tetearing algorithm could increase precision @@ -236,6 +237,7 @@ file should also be produced and should look like this: "kind" : "dev", "author" : "Larry A. Gardner", "details" : "All function calls are currently implemented without side effects", + "custom:experimental": "This is an experimental contract.", "methods" : { "age(uint256)" :