This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 5c718760fb docs: fix spelling errors in README.md (#4039)
5c718760fb is described below
commit 5c718760fbc3c614a2fcb3b08c3642cd541f3544
Author: Jason <[email protected]>
AuthorDate: Sun Jan 21 22:25:00 2024 +0800
docs: fix spelling errors in README.md (#4039)
---
examples/rust/00-setup/README.md | 8 ++++----
examples/rust/01-init-operator/README.md | 2 +-
examples/rust/02-async-io/README.md | 10 +++++-----
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/examples/rust/00-setup/README.md b/examples/rust/00-setup/README.md
index adacf030ed..702ab6e65b 100644
--- a/examples/rust/00-setup/README.md
+++ b/examples/rust/00-setup/README.md
@@ -34,12 +34,12 @@ Let's take a look over [`Cargo.toml`](Cargo.toml) first.
The most simple `Cargo.toml` will contains two parts:
-- `package`: The metadata of this package like `name`, `version`
+- `package`: The metadata of this package like `name`, `version`.
- `dependencies`: The dependencies that this package will depend on. `cargo`
will download them from <https://crates.io> and compile them.
### `src/`
-Than, let's read [`main.rs`](./src/main.rs).
+Then, let's read [`main.rs`](./src/main.rs).
The most simple `main.rs` will contain only one function: `fn main()`, this is
the entry of an application.
@@ -63,7 +63,7 @@ Declare our main function, this is the most simple function
that not take any in
println!("Hello, {}", Scheme::S3)
```
-- `println!()` is a built macro in rust to prints to the standard output, with
a newline. macro will be expanded to real code during compilation.
+- `println!()` is a built macro in rust to prints to the standard output, with
a newline. Macro will be expanded to real code during compilation.
- `"Hello, {}", Scheme::S3` is the format string in rust. It will convert
`Scheme::S3` to string, and construct a new string in this format.
## Build our first rust project!
@@ -91,7 +91,7 @@ Congrate! Our first rust project is built and running with
success!
After built, we will find that there are some new files created:
- `Cargo.lock`: Cargo.lock is a file generated by the cargo package manager
when you build or run a Rust project. It serves as a lock file and records the
exact versions of dependencies that were used during the previous successful
build or run of the project. It's always a good idea to commit `Cargo.lock` to
your repo, so developers can reproduce the same build result with you.
-- `target`: `target` folder is a directory automatically generated by rustc
and managed cargo. It contains the compiled artifacts and build output for
specific target platforms and architectures.
+- `target`: `target` folder is a directory automatically generated by `rustc`
and managed cargo. It contains the compiled artifacts and build output for
specific target platforms and architectures.
## Conclusion
diff --git a/examples/rust/01-init-operator/README.md
b/examples/rust/01-init-operator/README.md
index fee8dd3e30..3a7c79cc5e 100644
--- a/examples/rust/01-init-operator/README.md
+++ b/examples/rust/01-init-operator/README.md
@@ -108,7 +108,7 @@ fn init_operator_via_builder() -> Result<Operator> {
We have a new concept here:
-> `let mut builder = xxx;
+> let mut builder = xxx;
The `mut` here means `mutable`, allowing its value to be changed later.
diff --git a/examples/rust/02-async-io/README.md
b/examples/rust/02-async-io/README.md
index cbedd19233..d5890f5121 100644
--- a/examples/rust/02-async-io/README.md
+++ b/examples/rust/02-async-io/README.md
@@ -14,7 +14,7 @@ In this chapter's `Cargo.toml`, we add a new dependence
`tokio`:
tokio = { version = "1", features = ["full"] }
```
-The syntex is different from what we used before:
+The syntax is different from what we used before:
```diff
- tokio = "1"
@@ -104,7 +104,7 @@ impl Operator {
}
```
-`impl Into<Bytes>` here is a syntex suger of rust, we can expand it like the
following:
+`impl Into<Bytes>` here is a syntax sugar of rust, we can expand it like the
following:
```rust
impl Operator {
@@ -159,9 +159,9 @@ This API will read all data from `path` and return as a
`Vec<u8>`.
In this chapter we learnt a lot basic concepts in async rust! Now we have
known that:
-- How to setup tokio async runtime
-- How to define and call an async function
-- How to write and read data via OpenDAL
+- How to setup tokio async runtime.
+- How to define and call an async function.
+- How to write and read data via OpenDAL.
## Challenge Time
