From 9927e985a56466fdfbf89a248aca4388e89e004f Mon Sep 17 00:00:00 2001 From: mcisb <83702309+KyryloKilin@users.noreply.github.com> Date: Mon, 28 Oct 2024 13:48:50 +0300 Subject: [PATCH] chore: fix md typos (#302) Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com> --- CHANGELOG.md | 1 + docs/book/src/asset/base.md | 2 +- docs/book/src/asset/metadata.md | 2 +- docs/book/src/asset/supply.md | 4 ++-- docs/book/src/bytecode/index.md | 2 +- docs/book/src/index.md | 2 +- docs/book/src/pausable/index.md | 2 +- docs/book/src/signed_integers/index.md | 2 +- 8 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b37f1fd3..d79e4755 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ Description of the upcoming release here. - [#297](https://github.com/FuelLabs/sway-libs/pull/297) Fixes docs anchor in basic SRC-7 example. - [#298](https://github.com/FuelLabs/sway-libs/pull/298) Fixes the README headers on Upgradability Libraries from an `h2` to an `h4`. +- [#302](https://github.com/FuelLabs/sway-libs/pull/302) Fixes typos in documentation. #### Breaking diff --git a/docs/book/src/asset/base.md b/docs/book/src/asset/base.md index 054e51f9..c4d3aa0f 100644 --- a/docs/book/src/asset/base.md +++ b/docs/book/src/asset/base.md @@ -42,7 +42,7 @@ The following ABI and functions are also provided to set your [SRC-20](https://d ## Setting Up Storage -Once imported, the Asset Library's base functionality should be available. To use them, be sure to add the storage block bellow to your contract which enables the [SRC-20](https://docs.fuel.network/docs/sway-standards/src-20-native-asset/) standard. +Once imported, the Asset Library's base functionality should be available. To use them, be sure to add the storage block below to your contract which enables the [SRC-20](https://docs.fuel.network/docs/sway-standards/src-20-native-asset/) standard. ```sway {{#include ../../../../examples/asset/base_docs/src/main.sw:src20_storage}} diff --git a/docs/book/src/asset/metadata.md b/docs/book/src/asset/metadata.md index 8a0a807b..d4db48c8 100644 --- a/docs/book/src/asset/metadata.md +++ b/docs/book/src/asset/metadata.md @@ -26,7 +26,7 @@ The Asset Library has the following complimentary data type for the [SRC-7](http ## Setting Up Storage -Once imported, the Asset Library's metadata functionality should be available. To use them, be sure to add the storage block bellow to your contract which enables the [SRC-7](https://docs.fuel.network/docs/sway-standards/src-7-asset-metadata/) standard. +Once imported, the Asset Library's metadata functionality should be available. To use them, be sure to add the storage block below to your contract which enables the [SRC-7](https://docs.fuel.network/docs/sway-standards/src-7-asset-metadata/) standard. ```sway {{#include ../../../../examples/asset/metadata_docs/src/main.sw:src7_storage}} diff --git a/docs/book/src/asset/supply.md b/docs/book/src/asset/supply.md index 9057f994..cb3fcf82 100644 --- a/docs/book/src/asset/supply.md +++ b/docs/book/src/asset/supply.md @@ -29,7 +29,7 @@ The Asset Library has the following complimentary functions for each function in ## Setting Up Storage -Once imported, the Asset Library's supply functionality should be available. To use them, be sure to add the storage block bellow to your contract which enables the [SRC-3](https://docs.fuel.network/docs/sway-standards/src-3-minting-and-burning/) standard. +Once imported, the Asset Library's supply functionality should be available. To use them, be sure to add the storage block below to your contract which enables the [SRC-3](https://docs.fuel.network/docs/sway-standards/src-3-minting-and-burning/) standard. ```sway {{#include ../../../../examples/asset/supply_docs/src/main.sw:src3_storage}} @@ -37,7 +37,7 @@ Once imported, the Asset Library's supply functionality should be available. To ## Implementing the SRC-3 Standard with the Asset Library -To use either function, simply pass the `StorageKey` from the prescribed storage block. The example below shows the implementation of the [SRC-3](https://docs.fuel.network/docs/sway-standards/src-3-minting-and-burning/) standard in combination with the Asset Library with no user defined restrictions or custom functionality. It is recommended that the [Ownership Library](../ownership/index.md) is used in conjunction with the Asset Library;s supply functionality to ensure only a single user has permissions to mint an Asset. +To use either function, simply pass the `StorageKey` from the prescribed storage block. The example below shows the implementation of the [SRC-3](https://docs.fuel.network/docs/sway-standards/src-3-minting-and-burning/) standard in combination with the Asset Library with no user defined restrictions or custom functionality. It is recommended that the [Ownership Library](../ownership/index.md) is used in conjunction with the Asset Library's supply functionality to ensure only a single user has permissions to mint an Asset. The `_mint()` and `_burn()` functions follows the SRC-20 standard for logging and will emit the `TotalSupplyEvent` when called. diff --git a/docs/book/src/bytecode/index.md b/docs/book/src/bytecode/index.md index 0bebfc3c..e6ff36a1 100644 --- a/docs/book/src/bytecode/index.md +++ b/docs/book/src/bytecode/index.md @@ -73,7 +73,7 @@ To verify a contract's bytecode root you may call `verify_bytecode_root()` or `v ### Computing the Address from Bytecode -To compute a predicates's address you may call the `compute_predicate_address()` or `compute_predicate_address_with_configurables()` functions. +To compute a predicate's address you may call the `compute_predicate_address()` or `compute_predicate_address_with_configurables()` functions. ```sway {{#include ../../../../examples/bytecode/src/main.sw:compute_predicate_address}} diff --git a/docs/book/src/index.md b/docs/book/src/index.md index b5fa21ae..27e68d9b 100644 --- a/docs/book/src/index.md +++ b/docs/book/src/index.md @@ -2,7 +2,7 @@ The purpose of Sway Libraries is to contain libraries which users can import and use that are not part of the standard library. -There are several types of libraries that Sway Libs encompases. These include libraries that provide convenience functions, [Sway-Standards](https://github.com/FuelLabs/sway-standards) supporting libraries, data type libraries, security functionality libraries, and other tools valuable to blockchain development. +There are several types of libraries that Sway Libs encompasses. These include libraries that provide convenience functions, [Sway-Standards](https://github.com/FuelLabs/sway-standards) supporting libraries, data type libraries, security functionality libraries, and other tools valuable to blockchain development. For implementation details on the libraries please see the [Sway Libs Docs](https://fuellabs.github.io/sway-libs/master/sway_libs/). diff --git a/docs/book/src/pausable/index.md b/docs/book/src/pausable/index.md index ee72d18b..f0a56569 100644 --- a/docs/book/src/pausable/index.md +++ b/docs/book/src/pausable/index.md @@ -47,7 +47,7 @@ When developing a contract, you may want to lock functions down to a specific st It is highly recommended to integrate the [Ownership Library](../ownership/index.md) with the Pausable Library and apply restrictions the `pause()` and `unpause()` functions. This will ensure that only a single user may pause and unpause a contract in cause of emergency. Failure to apply this restriction will allow any user to obstruct a contract's functionality. -The follow example implements the `Pausable` abi and applies restrictions to it's pause/unpause functions. The owner of the contract must be set in an constructor defined by `MyConstructor` in this example. +The follow example implements the `Pausable` abi and applies restrictions to it's pause/unpause functions. The owner of the contract must be set in a constructor defined by `MyConstructor` in this example. ```sway {{#include ../../../../examples/pausable/pausable_with_ownership/src/main.sw:impl_with_ownership}} diff --git a/docs/book/src/signed_integers/index.md b/docs/book/src/signed_integers/index.md index e15e290b..4a601401 100644 --- a/docs/book/src/signed_integers/index.md +++ b/docs/book/src/signed_integers/index.md @@ -16,7 +16,7 @@ To import the Signed Integer Number Library to your Sway Smart Contract, add the {{#include ../../../../examples/signed_integers/src/main.sw:import}} ``` -In order to use the any of the Signed Integer types, import them into your Sway project like so: +In order to use any of the Signed Integer types, import them into your Sway project like so: ```sway {{#include ../../../../examples/signed_integers/src/main.sw:import_8}}