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.

Sign up for GitHub

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

Jump to bottom

fix: typos in documentation files #15248

Merged
merged 6 commits into from
Nov 16, 2024
+5 −5
Merged

fix: typos in documentation files #15248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
288bd20
Update RELEASE.md
leopardracer Nov 8, 2024
3596710
Update RUST_CODING_STYLE.md
leopardracer Nov 9, 2024
9ebe9d3
Update release_notes.md
leopardracer Nov 9, 2024
1f6ec71
Update README.md.gotmpl
leopardracer Nov 9, 2024
3c0d1a0
Update from_bcs.md
leopardracer Nov 9, 2024
1b5327e
Update terraform/helm/aptos-node/README.md.gotmpl
davidiw Nov 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ The aptos cli release tags are created to track the CLI versions for community t
* [day 0] A release branch `aptos-release-vx.y` will be created, with a commit hash `abcde`. The full test suite will be triggered for the commit hash for validation.
* [day 1] The release will be deployed to **devnet**.
* [day 7] Once the release passed devnet test, a release tag `aptos-node-vx.y.z.rc` will be created, and get deployed to **testnet**.
* [day 10] After the binary release stablized on testnet, testnet framework will be upgraded.
* [day 10] After the binary release stabilized on testnet, testnet framework will be upgraded.
* Hot-fixes release will be created as needed when a release version is soaking in testnet, and we will only promote a release from testnet to Mainnet after confirming a release version is stable.
* [day 14] Once confirmed that both binary upgrade and framework upgrade stablized on testnet, a release tag `aptos-node-vx.y.z` will be created, the release version will be deployed to 1% of the stake on **Mainnet**.
* [day 14] Once confirmed that both binary upgrade and framework upgrade stabilized on testnet, a release tag `aptos-node-vx.y.z` will be created, the release version will be deployed to 1% of the stake on **Mainnet**.
* [day 16] Wider announcement will be made for the community to upgrade the binary, `aptos-node-vx.y.z` will be updated with "[Mainnet]" in the release page, Mainnet validators will be slowly upgrading.
* [day 17] A list of framework upgrade proposals will be submitted to Mainnet for voting.
* [day 24] Proposals executed on-chain if passed voting.
Expand Down
2 changes: 1 addition & 1 deletion RUST_CODING_STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `--check` flag can be used to check if the code is formatted correctly.
./scripts/rust_lint.sh
```

> **Note:** xclippy is an alias for `cargo clippy` with additional flags to enable more lints.
> **Note:** clippy is an alias for `cargo clippy` with additional flags to enable more lints.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's actually xclippy https://github.com/aptos-labs/aptos-core/blob/main/.cargo/config.toml#L2

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

8dc501b
Good call, fixed

## Code documentation

Expand Down
2 changes: 1 addition & 1 deletion aptos-move/framework/aptos-stdlib/doc/from_bcs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

This module provides a number of functions to convert _primitive_ types from their representation in <code>std::bcs</code>
to values. This is the opposite of <code><a href="../../move-stdlib/doc/bcs.md#0x1_bcs_to_bytes">bcs::to_bytes</a></code>. Note that it is not safe to define a generic public <code>from_bytes</code>
function because this can violate implicit struct invariants, therefore only primitive types are offerred. If
function because this can violate implicit struct invariants, therefore only primitive types are offered. If
a general conversion back-and-force is needed, consider the <code>aptos_std::Any</code> type which preserves invariants.

Example:
Expand Down
2 changes: 1 addition & 1 deletion ecosystem/indexer-grpc/release_notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This file keeps track of the changes for indexer grpc.

* Changed the internal data format to raw bytes, this can save at 40% traffic cost.

* Server supports request and respone compression. [PR](https://github.com/aptos-labs/aptos-core/pull/7907)
* Server supports request and response compression. [PR](https://github.com/aptos-labs/aptos-core/pull/7907)


## [0.1.0] - 2023.03.28
Expand Down
Loading