Language cleanup (#68)

szaydel · web-flow · commit e577a805ec4e · 2024-07-04T23:30:02.000+08:00
diff --git a/book-src/01-01-read-file-line-by-line.md b/book-src/01-01-read-file-line-by-line.md
@@ -1,6 +1,6 @@
 # Read file line by line
 
-There is a [`Reader`] type in Zig, which provides various methods to read file, such as `readAll`, `readInt`, here we will use `streamUntilDelimiter` to split lines.
+There is a [`Reader`] type in Zig, which provides various methods to read file, such as `readAll`, `readInt`. Here we will use `streamUntilDelimiter` to split lines.
 
 ```zig
 {{#include ../src/01-01.zig }}
diff --git a/book-src/01-02-mmap-file.md b/book-src/01-02-mmap-file.md
@@ -1,6 +1,6 @@
 # Mmap file
 
-Creates a memory map of a file using [mmap](https://man7.org/linux/man-pages/man2/mmap.2.html) and simulates some non-sequential reads from the file. Using a memory map means you just index into a slice rather than dealing with seek to navigate a File.
+Creates a memory map of a file using [mmap](https://man7.org/linux/man-pages/man2/mmap.2.html) and simulates some non-sequential reads from the file. Using a memory map means you just index into a slice rather than having to deal with seek to navigate a file.
 
 ```zig
 {{#include ../src/01-02.zig }}
diff --git a/book-src/01-03-file-modified-24h-ago.md b/book-src/01-03-file-modified-24h-ago.md
@@ -1,8 +1,8 @@
 # Find files that have been modified in the last 24 hours
 
-Gets the current working directory by calling `fs.cwd()`, and then iterate files using `walk()`, which will recursively iterates over a directory.
+Gets the current working directory by calling `fs.cwd()`, and then iterates files using `walk()`, which will recursively iterate entries in the directory.
 
-For each entries, we check if it's a file, and use `statFile()` to retrieve file's metadata.
+For each entry, we check if it's a file, and use `statFile()` to retrieve the file's metadata.
 
 ```zig
 {{#include ../src/01-03.zig }}
diff --git a/book-src/03-01-elapsed-time.md b/book-src/03-01-elapsed-time.md
@@ -1,10 +1,10 @@
 ### Measure the elapsed time between two code sections
 
-[`Instant`] represents a timestamp with respect to the currently executing program that ticks during suspend and can be used to record elapsed time.
+[`Instant`] represents a timestamp with respect to the currently executing program that ticks while the program is suspended and can be used to record elapsed time.
 
 Calling [`std.time.Instant.since`] returns a u64 representing nanoseconds elapsed.
 
-This task is common, that there is a [`Timer`] for convenience.
+This is such a common task, that there is a [`Timer`] for convenience.
 
 ```zig
 {{#include ../src/03-01.zig }}
diff --git a/book-src/04-01-tcp-server.md b/book-src/04-01-tcp-server.md
@@ -22,4 +22,4 @@ instead of `127.0.0.1`, replace `net.Ip4Address.parse` by
 (And connect to something like `ip6-localhost`, depending on the way
 your machine is set up.)
 
-The next section will show how to connect this server using Zig code.
+The next section will show how to connect to this server using Zig code.
diff --git a/book-src/04-02-tcp-client.md b/book-src/04-02-tcp-client.md
@@ -1,6 +1,6 @@
 ## TCP Client
 
-In this example, we demonstrate how to create a TCP client to connect to the server from the previous section.
+In this example, we demonstrate creation of a TCP client to connect to the server from the previous section.
 You can run it using `zig build run-04-02 -- <port>`.
 
 ```zig
@@ -10,4 +10,3 @@ You can run it using `zig build run-04-02 -- <port>`.
 By default, the program connects with IPv4. If you want IPv6, use
 `::1` instead of `127.0.0.1`, replace `net.Address.parseIp4` by
 `net.Address.parseIp6`.
-
diff --git a/book-src/06-01-rand.md b/book-src/06-01-rand.md
@@ -1,6 +1,6 @@
 ## Generate random numbers
 
-Generates random numbers with help of a thread-local, cryptographically secure pseudo random number generator [`std.crypto.random`].
+Generates random numbers with the help of a thread-local, cryptographically secure pseudo random number generator [`std.crypto.random`].
 
 ```zig
 {{#include ../src/06-01.zig }}
diff --git a/book-src/07-02-shared-data.md b/book-src/07-02-shared-data.md
@@ -1,6 +1,6 @@
 ## Share data between two threads
 
-When we want to mutate data shared in different threads, [`Mutex`](**Mut**ually **ex**clusive flag) must be used to synchronize threads, otherwise the result maybe unexpected.
+When we want to mutate data shared between threads, [`Mutex`](**Mut**ually **ex**clusive flag) must be used to synchronize threads, otherwise the result maybe unexpected.
 
 ```zig
 {{#include ../src/07-02.zig}}
diff --git a/book-src/08-01-cpu-count.md b/book-src/08-01-cpu-count.md
@@ -1,6 +1,6 @@
 ## Check number of logical cpu cores
 
-Shows the number of logical CPU cores in current machine using [`std.Thread.getCpuCount`].
+Shows the number of logical CPU cores in the current machine using [`std.Thread.getCpuCount`].
 
 ```zig
 {{#include ../src/08-01.zig }}
diff --git a/book-src/08-02-external.md b/book-src/08-02-external.md
@@ -1,6 +1,6 @@
 # External Command
 
-Run external command via [`std.process.Child`], and collect output into `ArrayList` via [pipe].
+Run an external command via [`std.process.Child`], and collect output into `ArrayList` via [pipe].
 
 ```zig
 {{#include ../src/08-02.zig }}
diff --git a/book-src/10-02-base64.md b/book-src/10-02-base64.md
@@ -1,6 +1,6 @@
 ## Encode and decode base64
 
-Encodes byte slice into `base64` String using [`std.base64.standard`] [`encode`]
+Encodes a byte slice into `base64` string using [`std.base64.standard`] [`encode`]
 and decodes it with [`standard`] [`decode`].
 
 ```zig
diff --git a/book-src/12-01-bitfield.md b/book-src/12-01-bitfield.md
@@ -1,8 +1,8 @@
 # Bitfield
 
-The fields of a [packed struct](https://ziglang.org/documentation/master/#packed-struct) are always laid out in memory in the order they are written, with no padding, so they are very nice to represent bitfield.
+The fields of a [packed struct](https://ziglang.org/documentation/master/#packed-struct) are always laid out in memory in the order they are written, with no padding, so they are very nice to represent a bitfield.
 
-Boolean values are represented as 1 bit in packed struct, Zig also has arbitrary bit-width integers, like u28, u1 and so on.
+Boolean values are represented as 1 bit in a packed struct, Zig also has arbitrary bit-width integers, like u28, u1 and so on.
 
 ```zig
 {{#include ../src/12-01.zig }}
diff --git a/book-src/12-02-singly-linked-list.md b/book-src/12-02-singly-linked-list.md
@@ -1,13 +1,13 @@
 # Singly Linked List
 
-[Singly linked list] contains nodes linked together, the list contains:
+[Singly linked list] contains nodes linked together. The list contains:
 - `head`, head of the list, used for traversal.
 - `tail`, tail of the list, used for fast add.
 - `len`, length of the list
 
 Operations that can be performed on singly linked lists include:
 - Insertion O(1)
-- Deletion O(n), which is the most complex since it need to maintain head/tail pointer.
+- Deletion O(n), which is the most complex since it needs to maintain head/tail pointer.
 - Traversal O(n)
 
 ```zig
diff --git a/book-src/13-01-argparse.md b/book-src/13-01-argparse.md
@@ -1,6 +1,6 @@
 # Argument Parsing
 
-Parse arguments is common in command line programs and there are some packages in Zig help you ease the task, to name a few:
+Parsing arguments is common in command line programs and there are some packages in Zig to make this task easier. To name a few:
 
 - [Hejsil/zig-clap](https://github.com/Hejsil/zig-clap)
 - [MasterQ32/zig-args](https://github.com/MasterQ32/zig-args/)
diff --git a/book-src/14-01-sqlite.md b/book-src/14-01-sqlite.md
@@ -1,6 +1,6 @@
 # SQLite
 
-Although there are some [wrapper package](https://github.com/vrischmann/zig-sqlite) for SQLite in Zig, they are unstable. So here we will introduce the [C API interface](https://www.sqlite.org/cintro.html).
+Although there are some [wrapper package](https://github.com/vrischmann/zig-sqlite) options for SQLite in Zig, they are unstable. So here we will introduce the [C API interface](https://www.sqlite.org/cintro.html).
 
 Data models are introduced [here](database.md).
 
diff --git a/book-src/14-02-postgres.md b/book-src/14-02-postgres.md
@@ -2,9 +2,9 @@
 
 As with [previous section](./14-01-sqlite.md), here we introduce [libpq](https://www.postgresql.org/docs/16/libpq-example.html) interface directly, other than [wrapper package](https://github.com/tonis2/zig-postgres).
 
-Data models used in demo are the same with the one used in [SQLite section](./14-01-sqlite.md).
+Data models used in this demo are the same with the one used in [SQLite section](./14-01-sqlite.md).
 
-> Note: After execute a query with `PQexec` like functions, if there are returning results, check the result with `PGRES_TUPLES_OK`, otherwise `PGRES_COMMAND_OK` should be used.
+> Note: After executing a query with `PQexec` like functions, if there are returning results, check the result with `PGRES_TUPLES_OK`, otherwise `PGRES_COMMAND_OK` should be used.
 
 - <https://www.postgresql.org/docs/current/libpq-exec.html#LIBPQ-PQRESULTSTATUS>
 
diff --git a/book-src/14-03-mysql.md b/book-src/14-03-mysql.md
@@ -4,7 +4,7 @@ As with [sqlite section](./14-01-sqlite.md), here we introduce [libmysqlclient](
 
 Data models are introduced [here](database.md).
 
-> Note: After execute a query with `mysql_real_query` like functions, if there are returning results, we must consume the result, Otherwise we will get following error when we execute next query.
+> Note: After executing a query with `mysql_real_query` like functions, if there are returning results, we must consume the result, otherwise we will get following error when we execute next query.
 
 ```
 Commands out of sync; you can't run this command now
diff --git a/book-src/database.md b/book-src/database.md
@@ -2,10 +2,10 @@
 
 This section will demonstrate how to connect to popular databases from Zig.
 
-Data model used are as follows:
+Data model used is as follows:
 
 1. Create two tables: `cat_colors`, `cats`, `cats` has a reference in `cat_colors`.
-2. Create prepare statement for each table, and insert data.
+2. Create a prepare statement for each table, and insert data.
 3. Execute a join query to get `cat_name` and `color_name` at the same time.
 
 ## cat_colors
