Explorar o código

Consistent case for Solang

Signed-off-by: Sean Young <sean@mess.org>
Sean Young %!s(int64=4) %!d(string=hai) anos
pai
achega
42df316ac3
Modificáronse 4 ficheiros con 9 adicións e 10 borrados
  1. 4 4
      docs/extension.rst
  2. 3 4
      docs/installing.rst
  3. 1 1
      docs/language.rst
  4. 1 1
      docs/running.rst

+ 4 - 4
docs/extension.rst

@@ -24,8 +24,8 @@ Using the extension
 
 
 The extension can be found on the `Visual Studio Marketplace <https://marketplace.visualstudio.com/items?itemName=solang.solang>`_.
 The extension can be found on the `Visual Studio Marketplace <https://marketplace.visualstudio.com/items?itemName=solang.solang>`_.
 
 
-First, install the extension and the solang compiler binary. The extension needs
-to know where to find the solang binary to start the language server, and also
+First, install the extension and the Solang compiler binary. The extension needs
+to know where to find the Solang binary to start the language server, and also
 it needs to know what target you wish to compile your solidity code for.
 it needs to know what target you wish to compile your solidity code for.
 
 
 .. image:: extension-config.png
 .. image:: extension-config.png
@@ -35,7 +35,7 @@ Development
 
 
 The code is spread over two parts. The first part the vscode extension client code,
 The code is spread over two parts. The first part the vscode extension client code,
 `written in TypeScript <https://github.com/hyperledger-labs/solang/tree/main/vscode>`_.
 `written in TypeScript <https://github.com/hyperledger-labs/solang/tree/main/vscode>`_.
-This part deals with syntax highlighting, and calling out to the solang language server when
+This part deals with syntax highlighting, and calling out to the Solang language server when
 needed. The client needs `npm and node installed <https://docs.npmjs.com/downloading-and-installing-node-js-and-npm>`_.
 needed. The client needs `npm and node installed <https://docs.npmjs.com/downloading-and-installing-node-js-and-npm>`_.
 The client implementation is present in
 The client implementation is present in
 `src/client <https://github.com/hyperledger-labs/solang/tree/main/vscode/src/client>`_.
 `src/client <https://github.com/hyperledger-labs/solang/tree/main/vscode/src/client>`_.
@@ -43,7 +43,7 @@ The extension client code is in
 `src/client/extension.ts <https://github.com/hyperledger-labs/solang/tree/main/vscode/src/client/extension.ts>`_.
 `src/client/extension.ts <https://github.com/hyperledger-labs/solang/tree/main/vscode/src/client/extension.ts>`_.
 
 
 Secondly, there is the language server which is written in Rust.
 Secondly, there is the language server which is written in Rust.
-The solang binary has an option ``--language-server``, which start the
+The Solang binary has an option ``--language-server``, which start the
 `built-in language server <https://github.com/hyperledger-labs/solang/blob/main/src/bin/languageserver/mod.rs>`_.
 `built-in language server <https://github.com/hyperledger-labs/solang/blob/main/src/bin/languageserver/mod.rs>`_.
 
 
 Once you have node and npm installed, you can build the extension like so:
 Once you have node and npm installed, you can build the extension like so:

+ 3 - 4
docs/installing.rst

@@ -30,8 +30,7 @@ There is a release `v0.1.6` tag and a `latest` tag:
 	docker pull hyperledgerlabs/solang
 	docker pull hyperledgerlabs/solang
 
 
 The Solang binary is stored at ``/usr/bin/solang`` in this image. The `latest` tag
 The Solang binary is stored at ``/usr/bin/solang`` in this image. The `latest` tag
-gets updated each time there is a commit to the main branch of the solang
-git repository.
+gets updated each time there is a commit to the main branch of the Solang git repository.
 
 
 Build Solang using Dockerfile
 Build Solang using Dockerfile
 -----------------------------
 -----------------------------
@@ -51,7 +50,7 @@ Then you can build the image using:
 Building Solang from source
 Building Solang from source
 ---------------------------
 ---------------------------
 
 
-In order to build solang from source, you will need rust 1.43.0 or higher,
+In order to build Solang from source, you will need rust 1.43.0 or higher,
 and a build of llvm based on our tree. There are a few patches which are not upstream yet
 and a build of llvm based on our tree. There are a few patches which are not upstream yet
 First, follow the steps below for installing llvm and then proceed from there.
 First, follow the steps below for installing llvm and then proceed from there.
 
 
@@ -157,7 +156,7 @@ And on Windows, assuming *installdir* was ``C:\Users\User\solang-llvm``:
 Building Solang from crates.io
 Building Solang from crates.io
 ------------------------------
 ------------------------------
 
 
-The latest solang release is  on `crates.io <https://crates.io/crates/solang>`_. Once you have the
+The latest Solang release is  on `crates.io <https://crates.io/crates/solang>`_. Once you have the
 correct llvm version in your path, simply run:
 correct llvm version in your path, simply run:
 
 
 .. code-block:: bash
 .. code-block:: bash

+ 1 - 1
docs/language.rst

@@ -3097,7 +3097,7 @@ Tags
 
 
 Any contract, interface, library, event definition, struct definition, function, or contract variable
 Any contract, interface, library, event definition, struct definition, function, or contract variable
 may have tags associated with them. These are used for generating documentation for the contracts,
 may have tags associated with them. These are used for generating documentation for the contracts,
-when solang is run with the ``--doc`` command line option. This option generates some html which
+when Solang is run with the ``--doc`` command line option. This option generates some html which
 lists all the types, contracts, functions, and state variables along with their tags.
 lists all the types, contracts, functions, and state variables along with their tags.
 
 
 The tags use a special comment format. They can either be specified in block comments or single
 The tags use a special comment format. They can either be specified in block comments or single

+ 1 - 1
docs/running.rst

@@ -146,7 +146,7 @@ Now you should have a file called ``flipper.contract``. The file contains both t
 It can be used directly in the
 It can be used directly in the
 `Polkadot UI <https://substrate.dev/substrate-contracts-workshop/#/0/deploying-your-contract?id=putting-your-code-on-the-blockchain>`_, as if the contract was written in ink!.
 `Polkadot UI <https://substrate.dev/substrate-contracts-workshop/#/0/deploying-your-contract?id=putting-your-code-on-the-blockchain>`_, as if the contract was written in ink!.
 
 
-Using solang with Solana
+Using Solang with Solana
 ------------------------
 ------------------------
 
 
 The `Solana <https://www.solana.com/>`_ target is new and is limited right now, not all types are implemented
 The `Solana <https://www.solana.com/>`_ target is new and is limited right now, not all types are implemented