From b13901ed94c60204e253844b66dd1f4179bfaf38 Mon Sep 17 00:00:00 2001 From: djudjuu Date: Mon, 2 Sep 2019 12:53:35 +0200 Subject: [PATCH] minor CR: fixed links, parens and capitalization --- docs/compile.md | 4 ++-- docs/create_deploy.md | 2 +- docs/run.md | 2 +- docs/udapp.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/compile.md b/docs/compile.md index 4fb348b691..93a2d725e4 100644 --- a/docs/compile.md +++ b/docs/compile.md @@ -5,7 +5,7 @@ Clicking the Solidity icon in the icon panel brings you to the Solidty Compiler. Compiling is triggered when you click the compile button ( **D. in image below**). If you want the file to be compiled each time the file is saved or when another file is selected - check the auto compile checkbox ( **E. in image below**). -Since the Solidity version `0.5.7`, it is possible to compile `Yul` files. Please read the ([solidity documentation about Yul]https://solidity.readthedocs.io/en/latest/yul.html)) which contain some code examples. +Since the Solidity version `0.5.7`, it is possible to compile `Yul` files. Please read the ([solidity documentation about Yul](https://solidity.readthedocs.io/en/latest/yul.html)) which contain some code examples. You can use the language dropdown ( **B. in image below**) to switch the language. **This dropdown list is only available for versions greater than or equal to `0.5.7`.** The fork selection dropdown list ( **C. in image below**) allows to compile code against a specific ethereum hard fork. @@ -16,7 +16,7 @@ If the contract has a lot of dependencies it can take a while to compile - so yo ![](images/a-sol-compiler.png) After each compilation, a list is updated with all newly compiled -contracts. The compiled contract can be selected with the Contract pulldown menu ( **F. in image below**). Multiple contracts are compiled when one contract imports other contracts. Selecting a contract will show information about that one. +contracts. A compiled contract can be selected with the Contract pulldown menu ( **F. in image below**). Multiple contracts are compiled when one contract imports other contracts. Selecting a contract will show information about that one. When the "Compilation Details" button is clicked ( **G. in image below**), a modal opens displaying detailed information about the current selected contract. diff --git a/docs/create_deploy.md b/docs/create_deploy.md index 35614ec676..abb9da776f 100644 --- a/docs/create_deploy.md +++ b/docs/create_deploy.md @@ -61,7 +61,7 @@ Deploying an instance --------------------- The `Compile tab` displays information related to the current contract -(note that there can be more than one) ([(see compile](compile.html)). +(note that there can be more than one) ([see compile](compile.html)). Moving on, in the `Run tab` select, `JavaScript VM` to specify that you are going to deploy an instance of the contract in the `JavaScript VM` diff --git a/docs/run.md b/docs/run.md index 61ea4ce06b..c06630fbc9 100644 --- a/docs/run.md +++ b/docs/run.md @@ -112,7 +112,7 @@ The second corresponds to the deployment of the contract `test` with the first parameter of the constructor set to 11. That contract depends on a library. The linkage is done using the property `linkReferences`. In that case we use the address of the previously created library : -`created{1512830014773}`. the number is the id (timestamp) of the +`created{1512830014773}`. The number is the id (timestamp) of the transaction that led to the creation of the library. The third record corresponds to the call to the function `set` of the diff --git a/docs/udapp.md b/docs/udapp.md index 8d1932662d..a225d7b238 100644 --- a/docs/udapp.md +++ b/docs/udapp.md @@ -17,7 +17,7 @@ You will see the functions in the contract. The functions buttons can have diff - Functions that are `constant` or `pure` functions in Solidity have a blue buttons. Clicking one of this type does not create a new transaction. So clicking will not cause state changes - it will only return a value stored in the contract - so it won't cost you anything in gas fees. -- Functions that change the state of the contract are orange. Clicking on them will create a transaction and thus cost gas. Yet it is not possible to send Ether along with it. +- Functions that change the state of the contract AND that do not accept Ether are called `non-payable` functions and have an orange button. Clicking on them will create a transaction and thus cost gas. - Functions that have red buttons are `payable` functions in Solidity. Clicking one of these will create a new transaction and this transaction can accept a **value**. The **value** is put in in the Value field which is under the Gas Limit field.