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 in documentation files #15643

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][https://www.contributor-covenant.org/], version 1.4.
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4.

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

Expand Down
2 changes: 1 addition & 1 deletion aptos-move/framework/aptos-framework/doc/jwks.md
Original file line number Diff line number Diff line change
Expand Up @@ -861,7 +861,7 @@ For the example JWK set snapshot below containing 2 keys for Google found at htt
```

We can call update_federated_jwk_set for Google's <code>iss</code> - "https://accounts.google.com" and for each vector
argument <code>kid_vec</code>, <code>alg_vec</code>, <code>e_vec</code>, <code>n_vec</code>, we set in index 0 the corresponding attribute in the first JWK and we set in index 1 the
Copy link
Contributor

Choose a reason for hiding this comment

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

I think these files are auto-generated from their corresponding .move files. So unless you fix the typos there, the changes will be reverted.

Choose a reason for hiding this comment

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

I have updated .move and .rs source files.

argument <code>kid_vec</code>, <code>alg_vec</code>, <code>e_vec</code>, <code>n_vec</code>, we set in index 0 the corresponding attribute in the first JWK and we set in index 1
the corresponding attribute in the second JWK as shown below.

```move
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -710,7 +710,7 @@ is no longer possible.

## Function `add_override_aud_for_next_epoch`

Convenience method to queue up an append to to the set of override <code>aud</code>'s. The change will only be effective
Convenience method to queue up an append to the set of override <code>aud</code>'s. The change will only be effective
after reconfiguration. Only callable via governance proposal.

WARNING: If a malicious override <code>aud</code> is set, this *could* lead to stolen funds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -861,7 +861,7 @@ For the example JWK set snapshot below containing 2 keys for Google found at htt
```

We can call update_federated_jwk_set for Google's <code>iss</code> - "https://accounts.google.com" and for each vector
argument <code>kid_vec</code>, <code>alg_vec</code>, <code>e_vec</code>, <code>n_vec</code>, we set in index 0 the corresponding attribute in the first JWK and we set in index 1 the
argument <code>kid_vec</code>, <code>alg_vec</code>, <code>e_vec</code>, <code>n_vec</code>, we set in index 0 the corresponding attribute in the first JWK and we set in index 1
the corresponding attribute in the second JWK as shown below.

```move
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -710,7 +710,7 @@ is no longer possible.

## Function `add_override_aud_for_next_epoch`

Convenience method to queue up an append to to the set of override <code>aud</code>'s. The change will only be effective
Convenience method to queue up an append to the set of override <code>aud</code>'s. The change will only be effective
after reconfiguration. Only callable via governance proposal.

WARNING: If a malicious override <code>aud</code> is set, this *could* lead to stolen funds.
Expand Down
2 changes: 1 addition & 1 deletion crates/aptos-dkg/src/pvss/test_utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ pub struct DealingArgs<T: Transcript> {
pub dpk: T::DealtPubKey,
}

/// Helper function that, given a sharing configuration for `n` players, returns an a tuple of:
/// Helper function that, given a sharing configuration for `n` players, returns a tuple of:
/// - public parameters
/// - a vector of `n` signing SKs
/// - a vector of `n` signing PKs
Expand Down
2 changes: 1 addition & 1 deletion testsuite/test_framework/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Library for common python test framework utilities.

As opposed to to unit tests of core Rust components, which should be written in Rust along with the code, these python test utilities are for integration and e2e testing.
As opposed to unit tests of core Rust components, which should be written in Rust along with the code, these python test utilities are for integration and e2e testing.
2 changes: 1 addition & 1 deletion third_party/move/changes/4-unit-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ module 0x1::MyModule {
}
```

we would get get the following output:
we would get the following output:

```
$ cargo run --bin move-unit-test MyModule.move -g
Expand Down
4 changes: 2 additions & 2 deletions third_party/move/changes/7-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ understand.
A named address `N` in a package `P` is in scope if:
1. It declares a named address `N`; or
2. A package in one of `P`'s transitive dependencies declares the named address
`N` and there is a dependency path in the package graph between between `P` and the
`N` and there is a dependency path in the package graph between `P` and the
declaring package of `N` with no renaming of `N`.

Additionally, every named address in a package is exported. Because of this and
Expand Down Expand Up @@ -235,7 +235,7 @@ It is important to note that _renaming is not local_: once a named address `N`
has been renamed to `N2` in a package `P` all packages that import `P` will not
see `N` but only `N2` unless `N` is reintroduced from outside of `P`. This is
why rule (2) in the scoping rules at the start of this section specifies a
"dependency path in the package graph between between `P` and the declaring
"dependency path in the package graph between `P` and the declaring
package of `N` with no renaming of `N`."

### Instantiation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ fun add(x: u64, y: u64): u64 {
}
```

[As mentioned above](#function-body), the function's body is an [expression block](./variables.md). The expression block can sequence various statements, and the final expression in the block will be be the value of that block
[As mentioned above](#function-body), the function's body is an [expression block](./variables.md). The expression block can sequence various statements, and the final expression in the block will be the value of that block

[如上所述](#function-body),函数体是一个[表达式块](./variables.md)。表达式块中可以有各种各种语句,块中最后一个表达式将是该表达式块的值。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ understand.
A named address `N` in a package `P` is in scope if:
1. It declares a named address `N`; or
2. A package in one of `P`'s transitive dependencies declares the named address
`N` and there is a dependency path in the package graph between between `P` and the
`N` and there is a dependency path in the package graph between `P` and the
declaring package of `N` with no renaming of `N`.

在包`P`中的命名地址`N`如果满足以下条件,则在作用域内:
Expand Down Expand Up @@ -263,7 +263,7 @@ It is important to note that _renaming is not local_: once a named address `N`
has been renamed to `N2` in a package `P` all packages that import `P` will not
see `N` but only `N2` unless `N` is reintroduced from outside of `P`. This is
why rule (2) in the scoping rules at the start of this section specifies a
"dependency path in the package graph between between `P` and the declaring
"dependency path in the package graph between `P` and the declaring
package of `N` with no renaming of `N`."

重要的是要注意 _重命名不是局部的_:一旦一个命名地址`N`在一个包`P`中被重命名为`N2`,所有导入`P`的包都不会看到`N`但只会看到`N2`,除非`N`是从`P`外引入的。这就是为什么本节开头的范围规则中的规则 (2) 特别说明了“在`P`和没有重命名的声明包`N` 的封装图中的依赖路径” 。
Expand Down
Loading