更新文档, 提升版本号并发布

Author: Natural-selection1

Cargo.lock

@@ -12,7 +12,7 @@ keywords = [
 ]
 repository = "https://github.com/Natural-selection1/better-comprehension-in-rust"
 readme = "README.md"
-version = "3.0.2"
+version = "3.0.3"
 edition = "2024"
 exclude = [
     "src/main.rs",

Cargo.toml

@@ -1,4 +1,4 @@
-# better_comprehension
+# 更好的推导式
 
 在rust中的集合推导式和迭代器推导式, 提供更好的Rust使用体验
 
@@ -17,23 +17,50 @@
     (不计划支持, 因为本库已经提供了所有rust标准库中的集合类型)
 
   * 暂未支持while loop
-
-
+    (不计划支持, [使用let表达式](#let-表达式)就已经足够强大了)
 
 
 # 说明
-
-语法源自 [python推导式](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions)
+语法源自 [python推导式](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions), 但提供了更为强大的功能, 更接近 rust 的使用习惯
 
 本库为Rust标准库中的所有集合类型提供推导式宏
 ( Vec 和 std::collections::{BTreeMap, BTreeSet, BinaryHeap, HashMap, HashSet, LinkedList, VecDeque})
 
 以及基于引用的迭代器推导式宏
 
+## 语法总览
+值容器
 
+left_mapping < if `conditions` else `right_mapping` >?
+< for `pattern` in `iterable` < if `conditions` >?
+< let `expression` >* >+
 
-# 集合推导式
 
+[键值对容器](#键值对容器类型)
+
+支持三种键值对表示方式, 分别是 `=>` `,` `:`
+以下使用 `=>` 作为例子
+
+`left_key`=>`left_value` < if `conditions` else `right_key`=>`right_value`>?
+< for `pattern` in `iterable` < if `conditions` >?
+< let `expression` >* >+
+
+`?` 表示可选
+`+` 表示至少出现一次
+`*` 表示出现0次或多次
+换行不是必须的, 只是为了可读性
+
+`left/right_mapping/key/value` 是产生一个值的表达式, 可以是[简单表达式](#简单示例), 也可以是[块表达式](#使用块在返回前执行代码)
+
+`if conditions` 是一个产生bool的表达式
+
+`for pattern in iterable` 其中 `pattern` 是[模式](#使用模式匹配), `iterable` 是可迭代对象
+
+`let expression` 是一个let表达式, 可以[绑定变量](#使用let表达式绑定变量) 或者[执行任意代码](#使用-let-_--或-let---执行任意代码)
+
+
+
+# 集合推导式
 你可以完全将集合推导式宏视为 `for` 循环的语法糖
 (事实上, 这些宏就是使用 `for` 循环实现的)
 所以你可以看到很多很熟悉的语法

README-CN.md

@@ -22,9 +22,51 @@ Partially covered libraries:
 
   * Does not support while loop
 
+    (No plans to support this, [using let expression](#let-expression) is already powerful enough)
 
-# Collection Comprehensions
+# Overview
+The syntax is derived from [python comprehensions](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions), but provides more powerful features, closer to the usage of Rust
+
+This library provides comprehension macros for all collection types in the Rust standard library
+
+( Vec and std::collections::{BTreeMap, BTreeSet, BinaryHeap, HashMap, HashSet, LinkedList, VecDeque})
+
+And provides iterator comprehension macros based on references
+
+## Syntax
+Value container
+```ignore
+left_mapping <if conditions else right_mapping>?
+<for pattern in iterable <if conditions>?
+<let expression>*>+
+```
+
+[Key-value container](#key-value-collection-types)
+
+Supports three key-value pair representations, which are `=>` `,` `:`
+
+The following uses `=>` as an example
 
+```ignore
+left_key=>left_value <if conditions else right_key=>right_value>?
+<for pattern in iterable <if conditions>?
+<let expression>*>+
+```
+
+*`?` means optional*
+
+*`+` means at least once*
+
+*`*` means 0 times or more times*
+
+*It is not required to break lines, it is just for readability*
+
+* `left/right_mapping/key/value` is an expression that produces a value, which can be a [simple expression](#simple-example), or a [block expression](#execute-code-in-block-before-returning)
+* `if conditions` is an expression that produces a bool
+* `for pattern in iterable` where `pattern` is a [pattern](#use-pattern-matching), and `iterable` is an iterable object
+* `let expression` is a let expression, which can [bind variables](#use-let-expression-to-bind-variables) or [execute arbitrary code](#use-let-_--or-let---to-execute-code)
+
+# Collection Comprehensions
 You can completely treat collection comprehension macros as sugar for `for loop`
 (In fact, these macros are implemented using `for loop`)
 So you'll see many familiar syntaxes

README.md

@@ -23,6 +23,49 @@ Partially covered libraries:
 
   * Does not support while loop
 
+    (No plans to support this, [using let expression](#let-expression) is already powerful enough)
+
+# Overview
+The syntax is derived from [python comprehensions](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions), but provides more powerful features, closer to the usage of Rust
+
+This library provides comprehension macros for all collection types in the Rust standard library
+
+( Vec and std::collections::{BTreeMap, BTreeSet, BinaryHeap, HashMap, HashSet, LinkedList, VecDeque})
+
+And provides iterator comprehension macros based on references
+
+## Syntax
+Value container
+```ignore
+left_mapping <if conditions else right_mapping>?
+<for pattern in iterable <if conditions>?
+<let expression>*>+
+```
+
+[Key-value container](#key-value-collection-types)
+
+Supports three key-value pair representations, which are `=>` `,` `:`
+
+The following uses `=>` as an example
+
+```ignore
+left_key=>left_value <if conditions else right_key=>right_value>?
+<for pattern in iterable <if conditions>?
+<let expression>*>+
+```
+
+*`?` means optional*
+
+*`+` means at least once*
+
+*`*` means 0 times or more times*
+
+*It is not required to break lines, it is just for readability*
+
+* `left/right_mapping/key/value` is an expression that produces a value, which can be a [simple expression](#simple-example), or a [block expression](#execute-code-in-block-before-returning)
+* `if conditions` is an expression that produces a bool
+* `for pattern in iterable` where `pattern` is a [pattern](#use-pattern-matching), and `iterable` is an iterable object
+* `let expression` is a let expression, which can [bind variables](#use-let-expression-to-bind-variables) or [execute arbitrary code](#use-let-_--or-let---to-execute-code)
 
 # Collection Comprehensions