From 69956a30d9460d9bf0b3d2ad91fac6dfb3a4507d Mon Sep 17 00:00:00 2001 From: XiaoBei <1505929057@qq.com> Date: Wed, 8 Jan 2025 23:59:19 +0800 Subject: [PATCH] fix typos in documentation files (#20817) Co-authored-by: ronny-mysten <118224482+ronny-mysten@users.noreply.github.com> --- docs/content/guides/developer/coin/loyalty.mdx | 2 +- docs/content/guides/developer/cryptography/groth16.mdx | 2 +- docs/content/guides/developer/cryptography/multisig.mdx | 2 +- .../guides/developer/cryptography/zklogin-integration.mdx | 2 +- docs/content/guides/developer/getting-started/graphql-rpc.mdx | 2 +- docs/content/guides/developer/getting-started/sui-install.mdx | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/content/guides/developer/coin/loyalty.mdx b/docs/content/guides/developer/coin/loyalty.mdx index 6bf48ef1342c6..cd8698b69d37e 100644 --- a/docs/content/guides/developer/coin/loyalty.mdx +++ b/docs/content/guides/developer/coin/loyalty.mdx @@ -16,7 +16,7 @@ The loyalty.move source file contains the `examples::loyalty` module code that c {@inject: examples/move/token/sources/loyalty.move#struct=loyalty noComments} -The `init` function of the module uses the `LOYALTY` OTW to create the token. All `init` functions run one time only at the package publish event. The initializer function makes use of the OTW `LOYALTY` type defined previously in its call to `create_currency`. The function also defines a policy, sending both the policy capability and trasury capability to the address associated with the publish event. The holder of these transferrable capabilities can mint new `LOYALTY` tokens and modify their policies. +The `init` function of the module uses the `LOYALTY` OTW to create the token. All `init` functions run one time only at the package publish event. The initializer function makes use of the OTW `LOYALTY` type defined previously in its call to `create_currency`. The function also defines a policy, sending both the policy capability and treasury capability to the address associated with the publish event. The holder of these transferrable capabilities can mint new `LOYALTY` tokens and modify their policies. {@inject: examples/move/token/sources/loyalty.move#fun=init noComments} diff --git a/docs/content/guides/developer/cryptography/groth16.mdx b/docs/content/guides/developer/cryptography/groth16.mdx index d56b027a20602..614b373bbf6b1 100644 --- a/docs/content/guides/developer/cryptography/groth16.mdx +++ b/docs/content/guides/developer/cryptography/groth16.mdx @@ -18,7 +18,7 @@ The following example demonstrates how to create a Groth16 proof from a statemen ### Create circuit -In this example, we crate a proof which demonstrates that we know a factorisation `a * b = c` of a publicly known number `c` without revealing `a` and `b`. +In this example, we create a proof which demonstrates that we know a factorisation `a * b = c` of a publicly known number `c` without revealing `a` and `b`. ```circom pragma circom 2.1.5; diff --git a/docs/content/guides/developer/cryptography/multisig.mdx b/docs/content/guides/developer/cryptography/multisig.mdx index 4f1da03e92cc2..3a2e1d3a2c717 100644 --- a/docs/content/guides/developer/cryptography/multisig.mdx +++ b/docs/content/guides/developer/cryptography/multisig.mdx @@ -230,7 +230,7 @@ Each successful call to the command receives a response similar to the following ╰──────────────┴─────────────────────────────╯ ``` -Create two more shell variables to store the signatures, replaceing `` with the values from the previous command responses. +Create two more shell variables to store the signatures, replacing `` with the values from the previous command responses. ```sh $ SIG_1= diff --git a/docs/content/guides/developer/cryptography/zklogin-integration.mdx b/docs/content/guides/developer/cryptography/zklogin-integration.mdx index 7fa944e0c64ec..5c666ff735057 100644 --- a/docs/content/guides/developer/cryptography/zklogin-integration.mdx +++ b/docs/content/guides/developer/cryptography/zklogin-integration.mdx @@ -353,7 +353,7 @@ You might want to cache the ephemeral key pair along with the ZKP for future use However, the ephemeral key pair needs to be treated as a secret akin to a key pair in a traditional wallet. This is because if both the ephemeral private key and ZK proof are revealed to an attacker, then they can typically sign any transaction on behalf of the user (using the same process described previously). -Consequently, you should not store them persistently in an unsecure storage location, on any platform. For example, on browsers, use session storage instead of local storage to store the ephemeral key pair and the ZK proof. This is because session storage automatically clears its data when the browser session ends, while data in local storage persists indefinitely. +Consequently, you should not store them persistently in a storage location that is not secure, on any platform. For example, on browsers, use session storage instead of local storage to store the ephemeral key pair and the ZK proof. This is because session storage automatically clears its data when the browser session ends, while data in local storage persists indefinitely. ## Efficiency considerations diff --git a/docs/content/guides/developer/getting-started/graphql-rpc.mdx b/docs/content/guides/developer/getting-started/graphql-rpc.mdx index 428d141db5cf8..bc21140de197e 100644 --- a/docs/content/guides/developer/getting-started/graphql-rpc.mdx +++ b/docs/content/guides/developer/getting-started/graphql-rpc.mdx @@ -1,6 +1,6 @@ --- title: Querying Sui RPC with GraphQL -description: Intoductory guide to making queries of the Sui RPC using the GraphQL service. +description: Introductory guide to making queries of the Sui RPC using the GraphQL service. --- The quickest way to access the GraphQL service for Sui RPC is through the online IDE that provides a complete toolbox for fetching data and executing transactions on the network. The online IDE provides features such as auto-completion (use Ctrl+Space or just start typing), built-in documentation (Book icon, top-left), multi-tabs, and more. diff --git a/docs/content/guides/developer/getting-started/sui-install.mdx b/docs/content/guides/developer/getting-started/sui-install.mdx index 62ac3b6dd5476..d09a6cf53e9a5 100644 --- a/docs/content/guides/developer/getting-started/sui-install.mdx +++ b/docs/content/guides/developer/getting-started/sui-install.mdx @@ -421,7 +421,7 @@ With Sui installed, you can interact with Sui networks using the Sui CLI. For mo ## Installing Sui developer tools If you use VSCode, you can install the [Move extension](https://marketplace.visualstudio.com/items?itemName=mysten.move) to get language server support for Move, as well as support for building, testing, and debugging Move code within the IDE. -You can install the extension either by searhing the fully-qualified extension name, `Mysten.move`, in the extension view, or by pressing `Ctrl-P` or `Cmd-P` and typing `ext install mysten.move`. +You can install the extension either by searching the fully-qualified extension name, `Mysten.move`, in the extension view, or by pressing `Ctrl-P` or `Cmd-P` and typing `ext install mysten.move`. Installing the Move extension also installs the appropriate `move-analyzer` binary for your operating system, as well as the [Move Trace Debugger](https://marketplace.visualstudio.com/items?itemName=mysten.move-trace-debug) extension, and [Move Syntax](https://marketplace.visualstudio.com/items?itemName=damirka.move-syntax) extension. There are also community Move packages for [Emacs](https://github.com/amnn/move-mode) and [Vim](https://github.com/yanganto/move.vim).