cerc-io/solidity
10
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix documentation errors

Browse Source 
Subheadings must use consistent format across a file.

The metadata with comments cannot be parsed as JSON.
This commit is contained in:
Alex Beregszaszi 2016-11-30 12:16:55 +00:00 committed by chriseth
parent f91ae3f06b
commit ea7a6520b2
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/miscellaneous.rst
View File

@ -259,7 +259,7 @@ reduce whitespace to a minimum and sort the keys of all objects to arrive at a
unique formatting. unique formatting.
Comments are of course also not permitted and used here only for explanatory purposes. 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 // 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 Encoding of the Metadata Hash in the Bytecode
--------------------------------------------- =============================================
Because we might support other ways to retrieve the metadata file in the future, Because we might support other ways to retrieve the metadata file in the future,
the mapping ``{"bzzr0": <Swarm hash>}`` is stored 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. to match that pattern and use the Swarm hash to retrieve the file.
Usage for Automatic Interface Generation and NatSpec Usage for Automatic Interface Generation and NatSpec
---------------------------------------------------- ====================================================
The metadata is used in the following way: A component that wants to interact 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 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. whenever they interact with the contract.
Usage for Source Code Verification Usage for Source Code Verification
---------------------------------- ==================================
In order to verify the compilation, sources can be retrieved from Swarm In order to verify the compilation, sources can be retrieved from Swarm
via the link in the metadata file. via the link in the metadata file.