From 47b0f5a0997a6313524dbd2ebff516042229111e Mon Sep 17 00:00:00 2001 From: Sally MacFarlane Date: Tue, 11 Aug 2020 14:16:45 +1000 Subject: [PATCH] [MINOR] removed semicolons (#484) * , otherwise Signed-off-by: Sally MacFarlane * , otherwise Signed-off-by: Sally MacFarlane * semicolons begone Signed-off-by: Sally MacFarlane * semicolons begone Signed-off-by: Sally MacFarlane --- docs/HowTo/Get-Started/Install-Binaries.md | 4 ++-- docs/Reference/API-Methods.md | 16 ++++++++-------- docs/Reference/API-Objects.md | 12 ++++++------ docs/Reference/CLI/CLI-Syntax.md | 2 +- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/HowTo/Get-Started/Install-Binaries.md b/docs/HowTo/Get-Started/Install-Binaries.md index ba939a02..eca449b9 100644 --- a/docs/HowTo/Get-Started/Install-Binaries.md +++ b/docs/HowTo/Get-Started/Install-Binaries.md @@ -16,7 +16,7 @@ description: Install or upgrade Hyperledger Besu from binary distribution Hyperledger Besu requires: * MacOS High Sierra 10.13 or later versions - * Java 11+ to compile; earlier versions are not supported. You can install Java using + * Java 11+ to compile. Earlier versions are not supported. You can install Java using `brew cask install adoptopenjdk`. Alternatively, you can manually install the [Java JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). @@ -55,7 +55,7 @@ besu --help !!!attention - Besu requires Java 11+ to compile; earlier versions are not supported. + Besu requires Java 11+ to compile. Earlier versions are not supported. !!! note "Linux Open File Limit" diff --git a/docs/Reference/API-Methods.md b/docs/Reference/API-Methods.md index 9a18365f..c837a7a8 100644 --- a/docs/Reference/API-Methods.md +++ b/docs/Reference/API-Methods.md @@ -74,7 +74,7 @@ You can specify only one log level per RPC call. #### Returns -`result` : `Success` if the log level has changed; otherwise `error`. +`result` : `Success` if the log level has changed, otherwise `error`. This example changes the debug level for specified classes to `DEBUG`. @@ -183,7 +183,7 @@ is used as the starting point. #### Returns -`result` - Status of the repair request; either `Started`, or `Already running`. +`result` - Status of the repair request. Either `Started`, or `Already running`. !!! example @@ -842,7 +842,7 @@ None #### Returns -`result` (*BOOLEAN*) - `true` if the client is actively mining new blocks; otherwise `false`. +`result` (*BOOLEAN*) - `true` if the client is actively mining new blocks, otherwise `false`. !!! example @@ -1957,7 +1957,7 @@ The following example returns an estimate of 21000 wei (`0x5208`) for the transa The following example request estimates the cost of deploying a simple storage smart contract to the network. The data field contains the hash of the compiled contract you want to deploy. (You can -get the compiled contract hash from your IDE; for example, **Remix > Compile tab > details > +get the compiled contract hash from your IDE, for example, **Remix > Compile tab > details > WEB3DEPLOY**.) The result is 113355 wei. #### Returns @@ -2718,7 +2718,7 @@ minutes. #### Returns -`Boolean` - `true` if the filter was successfully uninstalled; otherwise `false`. +`Boolean` - `true` if the filter was successfully uninstalled, otherwise `false`. !!! example @@ -3012,7 +3012,7 @@ None * `DATA`, 32 Bytes - Hash of the current block header (pow-hash). * `DATA`, 32 Bytes - The seed hash used for the DAG. -* `DATA`, 32 Bytes - The required target boundary condition; 2^256 / difficulty. +* `DATA`, 32 Bytes - The required target boundary condition: 2^256 / difficulty. * `QUANTITY` - Hexadecimal integer representing the current block number. !!! example @@ -5356,7 +5356,7 @@ None ### priv_getPrivateTransaction -Returns the private transaction if you are a participant; otherwise, `null`. +Returns the private transaction if you are a participant, otherwise, `null`. #### Parameters @@ -5696,7 +5696,7 @@ for public contracts. #### Returns -`Boolean` - `true` if the filter was successfully uninstalled; otherwise `false`. +`Boolean` - `true` if the filter was successfully uninstalled, otherwise `false`. !!! example diff --git a/docs/Reference/API-Objects.md b/docs/Reference/API-Objects.md index 488af170..65f29a2f 100644 --- a/docs/Reference/API-Objects.md +++ b/docs/Reference/API-Objects.md @@ -100,7 +100,7 @@ Returned by [`priv_getPrivateTransaction`](API-Methods.md#priv_getprivatetransac | **hash** | Data, 32 bytes | Hash of the transaction. | | **input** | Data | The data to create or invoke a contract. | | **nonce** | Quantity | Number of transactions made by the sender to the privacy group before this one. | -| **to** | Data, 20 bytes | `null` if a contract creation transaction; otherwise, the contract address. | +| **to** | Data, 20 bytes | `null` if a contract creation transaction, otherwise, the contract address. | | **value** | Quantity | `null` because private transactions cannot transfer Ether. | | **v** | Quantity | ECDSA Recovery ID. | | **r** | Data, 32 bytes | ECDSA signature r. | @@ -145,7 +145,7 @@ Returned by [`debug_traceBlock`](API-Methods.md#debug_traceblock), | Key | Type | Value | |-----------------|:-------:|--------------------------------------------------------------------| | **gas** | Integer | Gas used by the transaction. | -| **failed** | Boolean | True if transaction failed; otherwise, false. | +| **failed** | Boolean | True if transaction failed, otherwise, false. | | **returnValue** | String | Bytes returned from transaction execution (without a `0x` prefix). | | **structLogs** | Array | Array of structured log objects. | @@ -199,14 +199,14 @@ Returned by [`eth_getTransactionReceipt`](API-Methods.md#eth_gettransactionrecei |-----------------------|:--------------------:|--------------------------------------------------------------------------------------| | **blockHash** | Data, 32 bytes | Hash of block containing this transaction. | | **blockNumber** | Quantity | Block number of block containing this transaction. | -| **contractAddress** | Data, 20 bytes | Contract address created, if contract creation transaction; otherwise, `null`. | +| **contractAddress** | Data, 20 bytes | Contract address created, if contract creation transaction, otherwise, `null`. | | **cumulativeGasUsed** | Quantity | Total amount of gas used by previous transactions in the block and this transaction. | | **from** | Data, 20 bytes | Address of the sender. | | **gasUsed** | Quantity | Amount of gas used by this specific transaction. | | **logs** | Array | Array of [log objects](#log-object) generated by this transaction. | | **logsBloom** | Data, 256 bytes | Bloom filter for light clients to quickly retrieve related logs. | | **status** | Quantity | Either `0x1` (success) or `0x0` (failure) | -| **to** | Data, 20 bytes | Address of the receiver, if sending ether; otherwise, null. | +| **to** | Data, 20 bytes | Address of the receiver, if sending ether, otherwise, null. | | **transactionHash** | Data, 32 bytes | Hash of the transaction. | | **transactionIndex** | Quantity, Integer | Index position of transaction in the block. | | **revertReason** | String | ABI-encoded string that displays the [reason for reverting the transaction](../HowTo/Send-Transactions/Revert-Reason.md). Only available if revert reason is [enabled](../Reference/CLI/CLI-Syntax.md#revert-reason-enabled). | @@ -238,9 +238,9 @@ Returned by [`priv_getTransactionReceipt`](API-Methods.md#priv_getTransactionRec | Key | Type | Value | |--------------------------------------|:----------------------------:|--------------------------------------------------------------------------------------------------------| -| **contractAddress** | Data, 20 bytes | Contract address created if a contract creation transaction; otherwise, `null`. | +| **contractAddress** | Data, 20 bytes | Contract address created if a contract creation transaction, otherwise, `null`. | | **from** | Data, 20 bytes | Address of the sender. | -| **output** | Data | RLP-encoded return value of a contract call if a value returns; otherwise, `null`. | +| **output** | Data | RLP-encoded return value of a contract call if a value returns, otherwise, `null`. | | **commitmentHash** | Data, 32 bytes | Hash of the privacy marker transaction. | | **transactionHash** | Data, 32 bytes | Hash of the private transaction. | | **privateFrom** | Data, 32 bytes | [Orion](https://docs.orion.pegasys.tech/en/stable/) public key of the sender. | diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index 1606d7d6..26f387c3 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -911,7 +911,7 @@ node-private-key-file="/home/me/me_node/myPrivateKey" ``` The private key file for the node. The default is the key file in the [data directory](#data-path). -If no key file exists, Besu creates a key file containing the generated private key; otherwise, the +If no key file exists, Besu creates a key file containing the generated private key, otherwise, the existing key file specifies the node private key. !!!attention