diff --git a/docs/contracts/creating-contracts.rst b/docs/contracts/creating-contracts.rst index f574a5a6a..8eb4e5f56 100644 --- a/docs/contracts/creating-contracts.rst +++ b/docs/contracts/creating-contracts.rst @@ -8,7 +8,7 @@ Contracts can be created "from outside" via Ethereum transactions or from within IDEs, such as `Remix `_, make the creation process seamless using UI elements. -One way to create contracts programmatically on Ethereum is via the JavaScript API `web3.js `_. +One way to create contracts programmatically on Ethereum is via the JavaScript API `web3.js `_. It has a function called `web3.eth.Contract `_ to facilitate contract creation. diff --git a/docs/contracts/events.rst b/docs/contracts/events.rst index 8618e7524..a7c7bc13f 100644 --- a/docs/contracts/events.rst +++ b/docs/contracts/events.rst @@ -151,6 +151,6 @@ The output of the above looks like the following (trimmed): Additional Resources for Understanding Events ============================================= -- `Javascript documentation `_ +- `Javascript documentation `_ - `Example usage of events `_ - `How to access them in js `_ diff --git a/docs/contributing.rst b/docs/contributing.rst index da949c136..c174e3f60 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -102,9 +102,9 @@ This can be easiest accomplished using Homebrew: ``brew install coreutils``. On Windows systems, make sure that you have a privilege to create symlinks, otherwise several tests may fail. Administrators should have that privilege, but you may also -`grant it to other users `_ +`grant it to other users `_ or -`enable Developer Mode `_. +`enable Developer Mode `_. Running the Tests ----------------- diff --git a/docs/examples/micropayment.rst b/docs/examples/micropayment.rst index f5037e6f7..6ce049457 100644 --- a/docs/examples/micropayment.rst +++ b/docs/examples/micropayment.rst @@ -36,7 +36,7 @@ Creating the signature Alice does not need to interact with the Ethereum network to sign the transaction, the process is completely offline. In this tutorial, we will sign messages in the browser -using `web3.js `_ and +using `web3.js `_ and `MetaMask `_, using the method described in `EIP-712 `_, as it provides a number of other security benefits. diff --git a/docs/introduction-to-smart-contracts.rst b/docs/introduction-to-smart-contracts.rst index 4e370a461..5a278ecfb 100644 --- a/docs/introduction-to-smart-contracts.rst +++ b/docs/introduction-to-smart-contracts.rst @@ -185,7 +185,7 @@ arguments ``from``, ``to`` and ``amount``, which makes it possible to track transactions. To listen for this event, you could use the following -JavaScript code, which uses `web3.js `_ to create the ``Coin`` contract object, +JavaScript code, which uses `web3.js `_ to create the ``Coin`` contract object, and any user interface calls the automatically generated ``balances`` function from above: .. code-block:: javascript diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst index 9a5847858..a5c7164bc 100644 --- a/docs/layout-of-source-files.rst +++ b/docs/layout-of-source-files.rst @@ -182,7 +182,7 @@ Syntax and Semantics Solidity supports import statements to help modularise your code that are similar to those available in JavaScript (from ES6 on). However, Solidity does not support the concept of -a `default export `_. +a `default export `_. At a global level, you can use import statements of the following form: diff --git a/docs/natspec-format.rst b/docs/natspec-format.rst index 01726fe86..b23a46090 100644 --- a/docs/natspec-format.rst +++ b/docs/natspec-format.rst @@ -46,7 +46,7 @@ for the purposes of NatSpec. - For Vyper, use ``"""`` indented to the inner contents with bare comments. See the `Vyper - documentation `__. + documentation `__. The following example shows a contract and a function using all available tags. diff --git a/docs/resources.rst b/docs/resources.rst index 9084037d9..df0e45019 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -28,7 +28,7 @@ Integrated (Ethereum) Development Environments * `Embark `_ Developer platform for building and deploying decentralized applications. - * `Foundry `_ + * `Foundry `_ Fast, portable and modular toolkit for Ethereum application development written in Rust. * `Hardhat `_ @@ -37,7 +37,7 @@ Integrated (Ethereum) Development Environments * `Remix `_ Browser-based IDE with integrated compiler and Solidity runtime environment without server-side components. - * `Truffle `_ + * `Truffle `_ Ethereum development framework. Editor Integrations @@ -50,7 +50,7 @@ Editor Integrations * IntelliJ - * `IntelliJ IDEA plugin `_ + * `IntelliJ IDEA plugin `_ Solidity plugin for IntelliJ IDEA (and all other JetBrains IDEs). * Sublime Text diff --git a/docs/style-guide.rst b/docs/style-guide.rst index 08050c751..35e7324c9 100644 --- a/docs/style-guide.rst +++ b/docs/style-guide.rst @@ -17,11 +17,11 @@ conflicts, project specific style guides take precedence. The structure and many of the recommendations within this style guide were taken from python's -`pep8 style guide `_. +`pep8 style guide `_. The goal of this guide is *not* to be the right way or the best way to write Solidity code. The goal of this guide is *consistency*. A quote from python's -`pep8 `_ +`pep8 `_ captures this concept well. .. note::