diff options
| author | Alex Beregszaszi <alex@rtfs.hu> | 2016-11-30 20:16:55 +0800 |
|---|---|---|
| committer | chriseth <c@ethdev.com> | 2016-12-01 23:03:59 +0800 |
| commit | ea7a6520b283f5dfc47c05d8b8088608d2b5f4f9 (patch) | |
| tree | 59d10e4a3538a6969bfcd9eeaed9e21fd58e8d9f | |
| parent | f91ae3f06b8b6ae273a42020e81f882141a0a78f (diff) | |
| download | dexon-solidity-ea7a6520b283f5dfc47c05d8b8088608d2b5f4f9.tar.gz dexon-solidity-ea7a6520b283f5dfc47c05d8b8088608d2b5f4f9.tar.zst dexon-solidity-ea7a6520b283f5dfc47c05d8b8088608d2b5f4f9.zip | |
Fix documentation errors
Subheadings must use consistent format across a file.
The metadata with comments cannot be parsed as JSON.
| -rw-r--r-- | docs/miscellaneous.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/miscellaneous.rst b/docs/miscellaneous.rst index c44b3e9e..1754752d 100644 --- a/docs/miscellaneous.rst +++ b/docs/miscellaneous.rst @@ -259,7 +259,7 @@ reduce whitespace to a minimum and sort the keys of all objects to arrive at a unique formatting. Comments are of course also not permitted and used here only for explanatory purposes. -.. code-block:: json +.. code-block:: none { // Required: The version of the metadata format @@ -327,7 +327,7 @@ Comments are of course also not permitted and used here only for explanatory pur Encoding of the Metadata Hash in the Bytecode ---------------------------------------------- +============================================= Because we might support other ways to retrieve the metadata file in the future, the mapping ``{"bzzr0": <Swarm hash>}`` is stored @@ -342,7 +342,7 @@ So in order to retrieve the data, the end of the deployed bytecode can be checke to match that pattern and use the Swarm hash to retrieve the file. Usage for Automatic Interface Generation and NatSpec ----------------------------------------------------- +==================================================== The metadata is used in the following way: A component that wants to interact with a contract (e.g. Mist) retrieves the code of the contract, from that @@ -356,7 +356,7 @@ Furthermore, Mist can use the userdoc to display a confirmation message to the u whenever they interact with the contract. Usage for Source Code Verification ----------------------------------- +================================== In order to verify the compilation, sources can be retrieved from Swarm via the link in the metadata file. |