From a2701bd2a384daaac06bd68be4728b64d81d7f5b Mon Sep 17 00:00:00 2001 From: crStiv Date: Mon, 10 Feb 2025 16:32:54 +0100 Subject: [PATCH] fix: multiple typos of different importance (#3286) Fixed some typos, hope it'll help in some way --------- Signed-off-by: crStiv --- CONTRIBUTING.md | 8 ++++---- examples/amm/README.md | 6 +++--- examples/gen-nft/README.md | 2 +- examples/rfq/README.md | 2 +- examples/social/README.md | 4 ++-- linera-views/DESIGN.md | 4 ++-- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd44091a657..4c25670983d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ being squashed should compile correctly and contain the PR number. Only commits in a PR accepted by at least one team member should be pushed to the main branch. -Please also make yourself familiar with the rest of the guidelines below. +Please also be sure to familiarize yourself with the rest of the guidelines below. ## Naming conventions @@ -98,7 +98,7 @@ cargo +nightly fmt features = ["test"] }` in the section `[dev-dependencies]` instead of repeating the dependencies already declared by the feature `test`. -* A few crates define the features `wasmtime` and `wasmer`. For conveniency, these crates also +* A few crates define the features `wasmtime` and `wasmer`. For convenience, these crates also define a `default` feature. As a consequence, these crates must always be included with the flag `no-default-features = true`. (This also applies to the self-dependencies of the previous rule.) @@ -176,7 +176,7 @@ command added just before the line declaring the test ``` #[ntest::timeout(600000)] ``` -If the test lasts longer than the fixed time then it fails. The unit of time is millisecond, so the `600000` corresponds +If the test lasts longer than the fixed time then it fails. The unit of time is a millisecond, so the `600000` corresponds to `600` seconds and so to `10` minutes. ### Tracking simultaneous threads in `tokio` @@ -229,7 +229,7 @@ scrape_configs: - targets: ['localhost:9090'] ``` -4. The Web app on `http://localhost:9090` provides a way to access to the metrics. Another way is to use the API as indicated below and the process the results. +4. The Web app on `http://localhost:9090` provides a way to access to the metrics. Another way is to use the API as indicated below and process the results. 5. The list of available metrics is available by looking at `http://localhost:9090/api/v1/label/__name__/values` 6. The instantaneous value of a metric over all sources is accessed via `http://localhost:9090/api/v1/query?query=up` with `up` the metric sought. 7. The values of metrics over an interval over all sources is accessed via `http://localhost:9090/api/v1/query_range?query=up&start=2023-01-04T12:00:00Z&end=2023-01-04T16:00:00Z&step=1s`. diff --git a/examples/amm/README.md b/examples/amm/README.md index 7be18a98137..4733a4c59ac 100644 --- a/examples/amm/README.md +++ b/examples/amm/README.md @@ -1,7 +1,7 @@ # Automated Market Maker (AMM) Example Application -This example implements an Automated Market Maker (AMM) which demonstrates DeFi capabilities of the -Linera protocol. Prerequisite for the AMM application is the `fungible` application, as we will +This example implements an Automated Market Maker (AMM) which demonstrates the DeFi capabilities of the +Linera protocol. The prerequisite for the AMM application is the `fungible` application, as we will be adding/removing liquidity and also performing a swap. ## How it works @@ -18,7 +18,7 @@ It supports the following operations. All operations need to be executed remotel adding liquidity, which currently can only be a chain owner. - Remove Liquidity: This withdraws tokens from the AMM. Given the index of the token you'd - like to remove (can be 0 or 1), and an amount of that token that you'd like to remove, it calculates + like to remove (can be 0 or 1), and the amount of that token that you'd like to remove, it calculates how much of the other token will also be removed based on the current AMM ratio. Then it removes the amounts from both tokens as a removal of liquidity. The owner, in this context, is the user removing liquidity, which currently can only be a chain owner. diff --git a/examples/gen-nft/README.md b/examples/gen-nft/README.md index c1010448e10..080b11dc0e6 100644 --- a/examples/gen-nft/README.md +++ b/examples/gen-nft/README.md @@ -155,7 +155,7 @@ Installing and starting the web server: cd examples/gen-nft/web-frontend npm install --no-save -# Start the server but not open the web page right away. +# Start the server but do not open the web page right away. BROWSER=none npm start & ``` diff --git a/examples/rfq/README.md b/examples/rfq/README.md index 552fda0ac4d..5b6c06776bb 100644 --- a/examples/rfq/README.md +++ b/examples/rfq/README.md @@ -18,7 +18,7 @@ possible that multiple requests could have been received: the user specifies whi responding to using a request ID, consisting of the other party's chain ID and a sequence number. User A, after receiving the quote, has the option to either cancel the whole request using the -`CancelRequest` operation, or accept it using the `AcceptQuote` operation. Cancelling the request +`CancelRequest` operation, or accept it using the `AcceptQuote` operation. Canceling the request removes it from the application state and notifies the other party. Accepting the request launches the exchange process. diff --git a/examples/social/README.md b/examples/social/README.md index cc086abd00c..15b78cc4c17 100644 --- a/examples/social/README.md +++ b/examples/social/README.md @@ -89,7 +89,7 @@ sleep 2 Type each of these in the GraphiQL interface and substitute the env variables with their actual values that we've defined above. Point your browser to http://localhost:8081. This is the wallet that didn't create the -application, so we have to request it from the creator chain. As the chain ID specify the +application, so we have to request it from the creator chain. As the chain ID specifies the one of the chain where it isn't registered yet: ```gql,uri=http://localhost:8081 @@ -144,7 +144,7 @@ Since 8081 is a subscriber. Let's see if it received any posts: # You can see th query { receivedPosts { keys { timestamp author index } } } ``` -This should now list one entry, with timestamp, author and an index. If we view that +This should now list one entry, with a timestamp, author and an index. If we view that entry, we can see the posted text as well as other values: ```gql diff --git a/linera-views/DESIGN.md b/linera-views/DESIGN.md index 49a8a8d025b..dcad3af214e 100644 --- a/linera-views/DESIGN.md +++ b/linera-views/DESIGN.md @@ -52,8 +52,8 @@ also need to accommodate other features: The rules for constructing keys are the following: * For the construction of `struct` objects of associated base key `base_key` we do the following: If the corresponding type has entries `entry_0`, ..., `entry_k` then the -base key of the object associated with the `k`-th entry is `[base_key * * * *]` with `[* * * *]` -the serialization of the number `k` considered as a `u32`. +base key of the object associated with the `k`-th entry is `[base_key * * * *]` where +`[* * * *]` are the four bytes of `k` as a `u32`. * For each view type, we have some associated data. Some are the hash, others the counts (e.g. for `LogView` and `QueueView`) and some the index. The corresponding enum is named `KeyTag` for each of those containers. For the index, the values are serialized.