Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos #5408

Closed
wants to merge 12 commits into from
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ jobs:
run: cargo install cargo-deps

# We require this check to avoid cyclic dependencies between 'fuels' and 'forc-pkg'.
# Detailed explanation is found in the echo below.
# A detailed explanation is found in the echo below.
- name: Check 'forc-pkg' dependencies for 'fuels' crates
run: |
deps=$(cargo deps --manifest-path forc-pkg/Cargo.toml)
Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/advanced/generic_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ purely shorthand for the sake of ergonomics.

## Trait Constraints

Important background to know before diving into trait constraints is that the `where` clause can be used to specify the required traits for the generic argument. So, when writing something like a `HashMap` you may
An important background to know before diving into trait constraints is that the `where` clause can be used to specify the required traits for the generic argument. So, when writing something like a `HashMap` you may
want to specify that the generic argument implements a `Hash` trait.

```sway
Expand All @@ -41,7 +41,7 @@ fn get_hashmap_key<T>(Key : T) -> b256
}
```

Of course, our `noop()` function is not useful. Often, a programmer will want to declare functions over types which satisfy certain traits.
Of course, our `noop()` function is not useful. Often, a programmer will want to declare functions over types that satisfy certain traits.
For example, let's try to implement the successor function, `successor()`, for all numeric types.

```sway
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/basics/structs_tuples_and_enums.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<!-- This section should explain structs in Sway -->
<!-- structs:example:start -->
Structs in Sway are a named grouping of types. You may also be familiar with structs via another name: _product types_. Sway does not make any significantly unique usages of structs; they are similar to most other languages which have structs. If you're coming from an object-oriented background, a struct is like the data attributes of an object.
Structs in Sway are a named grouping of types. You may also be familiar with structs via another name: _product types_. Sway does not make any significantly unique usages of structs; they are similar to most other languages that have structs. If you're coming from an object-oriented background, a struct is like the data attributes of an object.
<!-- structs:example:end -->

Firstly, we declare a struct named `Foo` with two fields. The first field is named `bar` and it accepts values of type `u64`, the second field is named `baz` and it accepts `bool` values.
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/reference/contributing_to_sway.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ There are many ways in which you may contribute to the Sway project, some of whi

Check out our [Help Wanted](https://github.com/FuelLabs/sway/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22), [Sway Book](https://github.com/FuelLabs/sway/issues?q=is%3Aopen+is%3Aissue+label%3A%22The+Sway+Book%22) or [Good First Issue](https://github.com/FuelLabs/sway/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) issues to find a suitable task.

If you are planning something big, for example, related to multiple components or changes current behaviors, make sure to open an issue to discuss with us before starting on the implementation.
If you are planning something big, for example, related to multiple components or changes in current behaviors, make sure to open an issue to discuss with us before starting on the implementation.

## Contribution flow

Expand Down
1 change: 1 addition & 0 deletions docs/book/src/reference/keywords.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ traits, etc.
The following is a list of keywords currently in use, with their
functionality described.


- `as` - rename items in `use` statements, e.g., `use type::a as alias_name`
nnsW3 marked this conversation as resolved.
Show resolved Hide resolved
- [`abi`](../sway-program-types/smart_contracts.md#the-abi-declaration) - defines a smart contract ABI in a syntactically similar way to traits
- [`break`](../basics/control_flow.md#break-and-continue) - exit a loop immediately
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/reference/solidity_differences.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The underlying virtual machine targeted by Sway is the FuelVM, specified [here](

## Word Size

Words in the FuelVM are 64 bits (8 bytes), rather than the 256 bits (32 bytes) of the EVM. Therefore, all primitive integers smaller and including `u64` are stored in registers; `u256`, being bigger than the registers, and hashes (the `b256` type) are not stored in registers but rather in memory. They are therefore pointers to a 32-byte memory region containing the their data.
Words in the FuelVM are 64 bits (8 bytes), rather than the 256 bits (32 bytes) of the EVM. Therefore, all primitive integers smaller and including `u64` are stored in registers; `u256`, being bigger than the registers, and hashes (the `b256` type) are not stored in registers but rather in memory. They are therefore pointers to a 32-byte memory region containing their data.

## Unsigned Integers Only

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/testing/unit-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ fn test_meaning_of_life() {
}
```

Each test function is ran as if it were the entry point for a
Each test function is run as if it were the entry point for a
[script](../sway-program-types/scripts.md). Tests "pass" if they return
successfully, and "fail" if they revert or vice versa while [testing failure](#testing-failure).

Expand Down
Loading