Skip to content

Commit

Permalink
Fix typos (#3161)
Browse files Browse the repository at this point in the history
* fix typos

* fix typo

* fix typos

* fix typos

* fix typo

* fix typos

* fix typos

* fix typo

* fix typos

* fix typo

* fix typo

* fix typos

* fix typos

* fix typo

* fix typo

* fix typo

* fix typos

* fix typos

* fix typo

* fix typos

* fix typos

* fix typos

* fix typo

* fix typo

* fix typos
  • Loading branch information
omahs committed Aug 30, 2023
1 parent 7fcd84b commit ae3137c
Show file tree
Hide file tree
Showing 25 changed files with 56 additions and 56 deletions.
8 changes: 4 additions & 4 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ FAQ

`Ctrl+S`: Compiles the active Solidity file

`Ctrl+Shift+S`: Compiles a Solidity file and runs a script when the script is displayed in the editor.<br>(go [here](running_js_scripts.html#compile-a-contract-and-run-a-script-on-the-fly) more info about this functionality)
`Ctrl+Shift+S`: Compiles a Solidity file and runs a script when the script is displayed in the editor.<br>(go [here](running_js_scripts.html#compile-a-contract-and-run-a-script-on-the-fly) for more info about this functionality)

### Solidity compiler

Expand Down Expand Up @@ -54,8 +54,8 @@ There is a plugin called `Flattener` which will stuff all the original code and

**Q:** Where is deploy button?

**A:** Its in the Deploy & Run module. If you haven't activated that module, you should do that by clicking Deploy & Run module in the Plugin Manager.
You could also activate everything you need to work with solidity on the landing page ( click the remix logo at the top left for the screen) and click the "Solidity" button in the environment section.
**A:** It's in the Deploy & Run module. If you haven't activated that module, you should do that by clicking Deploy & Run module in the Plugin Manager.
You could also activate everything you need to work with solidity on the landing page (click the remix logo at the top left of the screen) and click the "Solidity" button in the environment section.

**Q:** How to pass a tuple to a public function in Remix?

Expand All @@ -67,7 +67,7 @@ You could also activate everything you need to work with solidity on the landing

`pragma experimental ABIEncoderV2;` at the top of the solidity file.

For example, here's a solidity file with a struct is an input parameter.
For example, here's a solidity file with a struct as an input parameter.

```
pragma solidity >=0.4.22 <0.6.0;
Expand Down
4 changes: 2 additions & 2 deletions docs/code_contribution_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ Code Contribution Guide
=======================

Remix is an open source tool and we encourage everyone to help us improve it.
Please opening issues, give feedback or contribute by a pulling request
Please open issues, give feedback or contribute by a pulling request
to our codebase.

The Remix application is built with JavaScript and it doesn't use any frameworks. We rely on a selected set of npm modules, like `yo-yo`, `csjs-inject` and among others. Check out the `package.json` files in the Remix submodules to learn more about the stack.
The Remix application is built with JavaScript and it doesn't use any frameworks. We rely on a selected set of npm modules, like `yo-yo`, `csjs-inject` among others. Check out the `package.json` files in the Remix submodules to learn more about the stack.

To learn more, please visit our [GitHub page](https://github.com/ethereum/remix-project).
14 changes: 7 additions & 7 deletions docs/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ If there is not an active file in the editor or a file has not already been comp
Compiling is triggered when you:
- click the compile button (**D. in fig. 1 below**)
- use the shortcut `control + s`.
- right click on a file in the File Explorer and selecting **Compile** option
- right click on a file in the File Explorer and select the **Compile** option

![](images/a-sol-comp-basic.png)

### Auto Compile
If the auto compile checkbox (**B. in fig. 1 above**) is checked, compiliation will occur every few seconds (when the file is auto-saved) as well as when another file is selected.
If the auto compile checkbox (**B. in fig. 1 above**) is checked, compilation will occur every few seconds (when the file is auto-saved) as well as when another file is selected.
If a contract has a lot of dependencies, it can take a while to compile - so you use autocompilation at your discretion.

### Solidity versions & Remix functionality
Expand All @@ -44,14 +44,14 @@ When publishing a contract that imports other contracts, the main contract and a

**Published data contains the contract's metadata and the solidity source code.**

After either **Publish on IPFS** or **Publish on Swarm** is clicked a modal will pop up. This modal contains the contract's address as well as the addreses of the contracts that it imported and the address of the contract's **metadata**.
After either **Publish on IPFS** or **Publish on Swarm** is clicked a modal will pop up. This modal contains the contract's address as well as the addresses of the contracts that it imported and the address of the contract's **metadata**.

When the "Compilation Details" button is clicked (**G. in fig. 1**), a modal opens displaying detailed information about the current selected contract.

If you just want to get the **ABI** or the **Bytecode** - click the appropriate button see **H. in fig. 1**.

### Passive Contract Verification
When you publish your metadata to IPFS and deploy your code to the mainnet or a public testnet, the contract verification service **[Sourcify](https://sourcify.dev/)**, will verifiy your contracts without you needing to do anything.
When you publish your metadata to IPFS and deploy your code to the mainnet or a public testnet, the contract verification service **[Sourcify](https://sourcify.dev/)**, will verify your contracts without you needing to do anything.

### Compile and Run script
The Compile and Run script button (**E. in fig. 1**) is for compiling and then immediately running a script. It's a time saver so that you can write some code, automatically run script that sets state of the contract - thus allowing you to quickly understand how the code is working. ([more about Compile & Run](running_js_scripts.html?#compile-a-contract-and-run-a-script-on-the-fly))
Expand All @@ -67,7 +67,7 @@ Clicking on Advanced Compiler Configurations will open this panel (**M. in fig.

![](images/a-sol-comp-adv.png)

There is a radio button to choose whether to configure the compiler through the interface (**N. in fig 2**) or to use a JSON file for the cofiguration (**R. in fig 2**).
There is a radio button to choose whether to configure the compiler through the interface (**N. in fig 2**) or to use a JSON file for the configuration (**R. in fig 2**).

### Solidity or YUL
Since the Solidity version `0.5.7`, it is possible to compile `Yul` files. Please read the ([solidity documentation about Yul](https://docs.soliditylang.org/en/latest/yul.html)) which contain some code examples.
Expand All @@ -80,9 +80,9 @@ The `compiler default` corresponds to the default hard fork used by a specific v
To see the name of the hard fork used in the current compilation, click the "Compilation Details" button and in the `Metadata` section there will be a sub-section called **settings**. Open up the **settings** to see the EVM version's name.

### Enable optimization
According to the the Solidity Docs, "the optimizer tries to simplify complicated expressions, which reduces both code size and execution cost, i.e., it can reduce gas needed for contract deployment as well as for external calls made to the contract."
According to the Solidity Docs, "the optimizer tries to simplify complicated expressions, which reduces both code size and execution cost, i.e., it can reduce gas needed for contract deployment as well as for external calls made to the contract."

For recent versions of Solidity, it is [recommended to enable optimization](https://blog.soliditylang.org/2020/11/04/solidity-ama-1-recap/#why-do-you-think-people-are-generally-suspicious-of-the-optimizer-and-are-they-right-to-be) .
For recent versions of Solidity, it is [recommended to enable optimization](https://blog.soliditylang.org/2020/11/04/solidity-ama-1-recap/#why-do-you-think-people-are-generally-suspicious-of-the-optimizer-and-are-they-right-to-be).

To learn more about optimization, (**Q. in the fig 2**) visit the [Solidity docs on the optimizer](https://docs.soliditylang.org/en/latest/internals/optimizer.html).

Expand Down
6 changes: 3 additions & 3 deletions docs/contract_verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Then after verifying the implementation contract:
3. Paste the verified implementation contract's address in the Expected Implementation Address box.
4. Paste in the proxy contract address into the Contract Address box.

To explain this visually, verify the implmentation contract:
To explain this visually, verify the implementation contract:

![](images/a-cv-etherscan-verify-implementation.png)

Expand All @@ -76,7 +76,7 @@ Then check the "It's a proxy contract" checkbox and cut and paste the implementa
And then paste the address of the proxy contract into the Contract Address box.
![](images/a-cv-etherscan-verify-proxy2.png)

### Generate Verfication Scripts
### Generate Verification Scripts
Clicking the Generate Verification Scripts on the Verification page, will create a folder named etherscan in the Workspace's scripts folder that contains .ts files for verifying and returning the receipt status.

![](images/a-cv-etherscan-gen-scripts.png)
![](images/a-cv-etherscan-gen-scripts.png)
2 changes: 1 addition & 1 deletion docs/create_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ value (Ether) to the contract.

`setPN` is not payable (orange button - depending on the theme) : it is not possible to send value (Ether) to the contract.

Clicking on `get` will not execute a transaction (usually its a blue button - depending on the theme). It doesn't execute a transaction because a `get` does not modify the state (the variable `value`) of this instance.
Clicking on `get` will not execute a transaction (usually it's a blue button - depending on the theme). It doesn't execute a transaction because a `get` does not modify the state (the variable `value`) of this instance.

Because `get` is a **view function**, you can see the return value just below the
`get` button.
Expand Down
6 changes: 3 additions & 3 deletions docs/debugger.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This page will go over the Debugger's *Use generated sources* option, its naviga
![](images/a-debugger-overview.png)

### Use generated sources
This option is available for contracts using Solidity 0.7.2 or greater. See the solidity blog for more details about [generated sourcess](https://blog.soliditylang.org/2020/09/28/solidity-0.7.2-release-announcement/#notable-new-features).
This option is available for contracts using Solidity 0.7.2 or greater. See the solidity blog for more details about [generated sources](https://blog.soliditylang.org/2020/09/28/solidity-0.7.2-release-announcement/#notable-new-features).

Using **generated sources** will make it easier to audit your contracts. When the option is checked, you can step into those compiler outputs — while debugging.

Expand Down Expand Up @@ -99,7 +99,7 @@ Here is a full example of the **Memory** panel,

Some address slots have hex encoded values and those values are then decoded. For example, check position **0xa0** and **0x140**.
### Storage
This is the persistant storage.
This is the persistent storage.

![](images/a-debug-storage.png)

Expand All @@ -116,7 +116,7 @@ The refers to the value that the function will return.

![](images/a-debug-return.png)
### Full Storage Changes
This shows the persistant storage at the end of the function.
This shows the persistent storage at the end of the function.

![](images/a-debug-full-store-change.png)
## Breakpoints
Expand Down
4 changes: 2 additions & 2 deletions docs/file_explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Remix Desktop is a version of Remix IDE in an Electron app. Note that when using
(Browsers do crash causing localstorage & indexedDB to be corrupted)

Remix IDE can be connected to remote Git repos hosted in GitHub (or similar service) or in IPFS.
Most of the Git operations are done in the **DGit** pluin. (DGit stands for Decentralized GIT).
Most of the Git operations are done in the **DGit** plugin. (DGit stands for Decentralized GIT).

[Branch management](#branch-management) is also available at the bottom of the File Explorer when the Workspace is Git initialized.

Expand Down Expand Up @@ -89,7 +89,7 @@ Restore is only for uploading the backup zip file.
The Workspace operations to create **Solidity Test Workflow**, **Mocha Chai Test Workflow**, and **Slither Workflow** are for creating GitHub actions. When clicked, a .yml file is created in the .workflows folder of the active Workspace.

### Workspaces initialized with Git
Git intialized workspaces will have the Git icon next to them in the **Workspaces** select box.
Git initialized workspaces will have the Git icon next to them in the **Workspaces** select box.

![](images/a-fe-select-git.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/hardhat.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ If a hardhat project is shared through remixd and `localhost` workspace is loade

![](images/a-hardhat-compilation.png)

There is an info icon along side the label which redirects to a specific section of Remix official documentation that explains how to use Hardhat compilation.
There is an info icon alongside the label which redirects to a specific section of Remix official documentation that explains how to use Hardhat compilation.

One can check the `Enable Hardhat Compilation` box to run the compilation for Hardhat along with the Remix using the compiler configuration in `Solidity Compiler` plugin.

Expand Down
8 changes: 4 additions & 4 deletions docs/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ There are two main reasons for loading external files into Remix:

## Importing a library or dependency

When importing from NPM, or a URL (like github, a IPFS gateway, or a Swarm gateway) you do not need to do anything more than use the `import` statement in your contract. The dependencies do not need to be "preloaded" into the File Explorer's current Workspace before the contract is compiled.
When importing from NPM, or a URL (like github, an IPFS gateway, or a Swarm gateway) you do not need to do anything more than use the `import` statement in your contract. The dependencies do not need to be "preloaded" into the File Explorer's current Workspace before the contract is compiled.

Files loaded from the import statement are placed in the **Files Explorer's** current Workspace's `.deps` folder.

Expand Down Expand Up @@ -60,15 +60,15 @@ import "./myLovelyLovelyLib.sol";

### Importing a file from your computer's filesystem

This method uses **remixd** - the remix daemon. Please go to the [remixd docs](remixd.html) for instructions about how to bridge the divide between the browser and your computers filesystem.
This method uses **remixd** - the remix daemon. Please go to the [remixd docs](remixd.html) for instructions about how to bridge the divide between the browser and your computer's filesystem.

### More about the import keyword
For a detailed explanation of the `import` keyword see the
[Solidity documentation](https://docs.soliditylang.org/en/latest/layout-of-source-files.html?highlight=import#importing-other-source-files)


## Importing a files for manipulation
When importing from the home tab widgets or with a remix command in the console, the files are placed in the **root of the current Workspace** inside a folder the shows their source - eg github or gists.
## Importing files for manipulation
When importing from the home tab widgets or with a remix command in the console, the files are placed in the **root of the current Workspace** inside a folder that shows their source - eg github or gists.

### Import buttons on the Remix home tab
The Gist, Github, Swarm, IPFS, & HTTPS buttons are to assist in getting files into Remix so you can explore.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Supported browsers: Firefox, Chrome, Brave. We do not support use of Remix on ta
**Ethereum Remix**, the VSCode extension, see `here <https://marketplace.visualstudio.com/items?itemName=RemixProject.ethereum-remix>`__.
Documentation for the VSCode extension is located `here <https://github.com/ethereum/remix-vscode#ethereum-remix-project-extension-for-visual-studio-code>`__.

**Remix Documentation Translations** The Remix docs are currently in `English <https://remix-ide.readthedocs.io/en/latest/>`__ and `Simplied Chinese <https://remix-ide.readthedocs.io/zh_CN/latest/>`__. More languages are on the way.
**Remix Documentation Translations** The Remix docs are currently in `English <https://remix-ide.readthedocs.io/en/latest/>`__ and `Simplified Chinese <https://remix-ide.readthedocs.io/zh_CN/latest/>`__. More languages are on the way.

Remix Project
~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can also get there by clicking the **More** button in the featured plugin li
Plugin Manager
---------------

In Remix, you only need to load the functionality you need - and the Plugin Manger is where you manage what plugins are turned off or on.
In Remix, you only need to load the functionality you need - and the Plugin Manager is where you manage what plugins are turned off or on.

The Plugin Manager is also the place you go when you are creating your own plugin and you want to load your local plugin into Remix. In that case you'd click on the "Connect to a Local Plugin" link at the top of the Plugin Manager panel.

Expand Down
4 changes: 2 additions & 2 deletions docs/locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Note: a plugin is called by its **name** as specified in its profile. There are
2. **Native Optional Plugins** that are loaded on demand: **debugger**, **hardhat-provider**, **solidity**, **solidityStaticAnalysis**, **solidityUnitTesting**, and **vyper**
3. **External Plugins** to get these plugins' names, please go to [https://github.com/ethereum/remix-plugins-directory/tree/master/plugins](https://github.com/ethereum/remix-plugins-directory/tree/master/plugins).

### Deactiving a list of plugins
### Deactivating a list of plugins
```
https://remix.ethereum.org/?#deactivate=debugger
```
Expand Down Expand Up @@ -77,7 +77,7 @@ To link to Remix with a theme specified use this url:
```

### A URL example combining multiple parameters
To link to Remix with the a list of plugins activated and with:
To link to Remix with the list of plugins activated and with:

* the Learneth gaining the side panel's focus (because it is the last in the list)
* the Light theme loaded
Expand Down
4 changes: 2 additions & 2 deletions docs/plugin_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,13 @@ Clone repos from github & create GIT repos & use standard git commands. Also exp
<br>[Make an issue](https://github.com/klaytn-ozys/plug-and-klay/issues)

**Learneth** &nbsp; ![](images/pi-learneth.png) &nbsp; Remix & Solidity Tutorials
<br>Tutorials that contain quizes that teach users Solidity and Remix features.
<br>Tutorials that contain quizzes that teach users Solidity and Remix features.
<br>[Profile name](https://github.com/ethereum/remix-plugins-directory/blob/master/plugins/learneth/profile.json): learnEth
<br>[Documentation](https://remix-learneth-plugin.readthedocs.io/en/latest/index.html)
<br>[Make an issue](https://github.com/bunsenstraat/remix-learneth-plugin/issues)

**Lexon** &nbsp; ![](images/pi-lexon.png) &nbsp;
<br>Lexon is a language that reads like a legal contract and compile into Solidity (and then bytecode). This plugin allow you to take Lexon code and to
<br>Lexon is a language that reads like a legal contract and compile into Solidity (and then bytecode). This plugin allows you to take Lexon code and to
<br>[Profile name](https://github.com/ethereum/remix-plugins-directory/blob/master/plugins/lexon/profile.json): lexon
<br>[Documentation](https://gitlab.com/lexon-foundation/lexon-remix)
<br>[Make an issue](https://gitlab.com/lexon-foundation/lexon-remix/-/issues)
Expand Down
2 changes: 1 addition & 1 deletion docs/plugin_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ When plugins need to access other plugins for their operation, a modal will appe

![](images/a-permission-modal.png)

Often, the same plugin will want to do the same action multiple times. So when granting permission, its helpful to click the **Remember this choice** box. If you don't, you might get this modal repeatedly popping up.
Often, the same plugin will want to do the same action multiple times. So when granting permission, it's helpful to click the **Remember this choice** box. If you don't, you might get this modal repeatedly popping up.

## View permissions
You can view the permissions that you have granted to plugins by clicking on the **Permissions** button at the bottom of the **Plugin Manager**.
Expand Down

0 comments on commit ae3137c

Please sign in to comment.