diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b4cf94f..62575510 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ Description of the upcoming release here. ### Fixed - [#153](https://github.com/FuelLabs/sway-standards/pull/153) Actually write to storage in `set_src20_data()` in the SRC-20 multi asset example. +- [#155](https://github.com/FuelLabs/sway-standards/pull/155) Fix typos in docs/src/src-10-native-bridge.md, docs/src/src-2-inline-documentation.md, docs/src/src-6-vault.md, docs/src/src-8-bridged-asset.md, docs/src/src-9-metadata-keys.md. #### Breaking diff --git a/docs/src/src-10-native-bridge.md b/docs/src/src-10-native-bridge.md index 2348b207..1fb5b655 100644 --- a/docs/src/src-10-native-bridge.md +++ b/docs/src/src-10-native-bridge.md @@ -45,7 +45,7 @@ The `claim_refund()` function is called if something goes wrong in the bridging #### `DepositType` -The `DepositType` enum describes whether the bridged deposit is made to a address, contract, or contract and contains additional metadata. There MUST be the following variants in the `DepositType` enum: +The `DepositType` enum describes whether the bridged deposit is made to an address, contract, or contract and contains additional metadata. There MUST be the following variants in the `DepositType` enum: **`Address`: `()`** @@ -53,11 +53,11 @@ The `Address` variant MUST represent when the deposit is made to an address on t **`Contract`: `()`** -The `Contract` variant MUST represent when the deposit is made to an contract on the Fuel chain. +The `Contract` variant MUST represent when the deposit is made to a contract on the Fuel chain. **`ContractWithData`: `()`** -The `ContractWithData` variant MUST represent when the deposit is made to an contract and contains additional metadata for the Fuel chain. +The `ContractWithData` variant MUST represent when the deposit is made to a contract and contains additional metadata for the Fuel chain. ##### Example Deposit Type diff --git a/docs/src/src-2-inline-documentation.md b/docs/src/src-2-inline-documentation.md index 80045f34..bf5be8d9 100644 --- a/docs/src/src-2-inline-documentation.md +++ b/docs/src/src-2-inline-documentation.md @@ -272,7 +272,7 @@ Example: ### Other Sections -If the above described sections are not relevant for the information that needs to documented, a custom section with a arbitrary `h1` header may be utilized. +If the above described sections are not relevant for the information that needs to documented, a custom section with an arbitrary `h1` header may be utilized. Example: diff --git a/docs/src/src-6-vault.md b/docs/src/src-6-vault.md index cd84b7fa..87c6e0f4 100644 --- a/docs/src/src-6-vault.md +++ b/docs/src/src-6-vault.md @@ -50,8 +50,8 @@ This function returns the total assets under management by vault. Includes asset This is a helper function for getting the maximum amount of assets that can be deposited. It takes the hypothetical `receiver` `Identity`, the `underlying_asset` `AssetId`, and the `vault_sub_id` `SubId` of the sub vault as an arguments and returns the maximum amount of assets that can be deposited into the contract, for the given asset. - This function MUST return the maximum amount of assets that can be deposited into the contract, for the given `underlying_asset`, if the given `vault_sub_id` vault exists. -- This function MUST return an `Some(amount)` if the given `vault_sub_id` vault exists. -- This function MUST return an `None` if the given `vault_sub_id` vault does not exist. +- This function MUST return a `Some(amount)` if the given `vault_sub_id` vault exists. +- This function MUST return a `None` if the given `vault_sub_id` vault does not exist. - This function MUST account for both global and user specific limits. For example: if deposits are disabled, even temporarily, MUST return 0. #### `fn max_withdrawable(receiver: Identity, underlying_asset: AssetId, vault_sub_id: SubId) -> Option` @@ -59,8 +59,8 @@ This is a helper function for getting the maximum amount of assets that can be d This is a helper function for getting maximum withdrawable. It takes the hypothetical `receiver` `Identity`, the `underlying_asset` `AssetId`, and the `vault_sub_id` SubId of the sub vault as an argument and returns the maximum amount of assets that can be withdrawn from the contract, for the given asset. - This function MUST return the maximum amount of assets that can be withdrawn from the contract, for the given `underlying_asset`, if the given `vault_sub_id` vault exists. -- This function MUST return an `Some(amount)` if the given `vault_sub_id` vault exists. -- This function MUST return an `None` if the given `vault_sub_id` vault does not exist. +- This function MUST return a `Some(amount)` if the given `vault_sub_id` vault exists. +- This function MUST return a `None` if the given `vault_sub_id` vault does not exist. - This function MUST account for global limits. For example: if withdrawals are disabled, even temporarily, MUST return 0. ### Required logs diff --git a/docs/src/src-8-bridged-asset.md b/docs/src/src-8-bridged-asset.md index dab11cc1..c09192f2 100644 --- a/docs/src/src-8-bridged-asset.md +++ b/docs/src/src-8-bridged-asset.md @@ -28,7 +28,7 @@ Any bridged assets MUST use the name and symbol of the asset on the chain where #### `bridged:chain` -The key `bridged:chain` SHALL return an `String` variant of the chain ID where the asset was originally minted. +The key `bridged:chain` SHALL return a `String` variant of the chain ID where the asset was originally minted. #### `bridged:address` diff --git a/docs/src/src-9-metadata-keys.md b/docs/src/src-9-metadata-keys.md index cc220ca4..2dd33dca 100644 --- a/docs/src/src-9-metadata-keys.md +++ b/docs/src/src-9-metadata-keys.md @@ -180,11 +180,11 @@ The key `res:description` SHALL return a `String` variant describing the asset's #### `res:date` -The key `res:date` SHALL return a `Int` variant of a UNIX timestamp. +The key `res:date` SHALL return an `Int` variant of a UNIX timestamp. #### `res:block` -The key `res:block` SHALL return a `Int` variant of a block number. +The key `res:block` SHALL return an `Int` variant of a block number. ### Images