Skip to content

Commit d0ea63d

Browse files
committed
fix and polish docs (done by using Sonnet 4.6 for help)
1 parent eb9fc58 commit d0ea63d

13 files changed

Lines changed: 34 additions & 38 deletions

CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@
2020

2121
## 格式规范
2222
### 文档规范
23-
* 使用 `utf-8`
24-
* 中文与英文、数字间加空格,若有中文标点则可不加空格
25-
* 参照 [DoctreePages](https://github.com/JuliaRoadmap/DoctreePages.jl) 提供的特殊语法
23+
使用 `UTF-8` 编码;中文与英文、数字间加空格,若有中文标点则可不加空格。
2624

2725
### Julia 术语规范
2826
* 英文名称如 Julia、Windows 等词不使用 ``` `` ``` 且首字母大写

docs/basic/dict.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ julia> d["one"] # 查字典
1919
julia> d["one"]=100 # 改字典,若不存在则添加
2020
100
2121
22-
julia> d.count # 字典长度
22+
julia> length(d) # 字典长度
2323
2
2424
2525
julia> keys(d) # 目录列表

docs/basic/float.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 浮点数与实数运算
2-
浮点数是 IEEE 754 标准规定的,广泛用于数学运算的数据类型,用来表示可用于通常计算的实数
3-
以下是 Julia 预定义的浮点数类型
2+
浮点数是遵循 IEEE 754 标准的数据类型,广泛用于数学运算,用于表示实数的近似值
3+
以下是 Julia 预定义的浮点数类型
44

55
## 浮点数类型
66
| 类型 | 精度 | bit 数 |
@@ -12,9 +12,9 @@
1212
不同于整数,并不存在表示“非负实数”的类型,因为这是完全不必要的。
1313

1414
## 浮点数字面表示
15-
* 使用标准格式表示,例如 `1.234``1.3e8`(科学记数法),`.234`省略0
16-
* 存在麻烦的 16 进制表示方式
17-
* 也可以用 `_` 间隔
15+
* 使用标准格式表示,例如 `1.234``1.3e8`(科学记数法),`.234`省略 0
16+
* 也支持十六进制浮点字面量,规则较为特殊,详见[官方文档](https://docs.juliacn.com/latest/manual/integers-and-floating-point-numbers/#十六进制浮点数字面量)
17+
* 也可以用 `_` 间隔数字以提高可读性,如 `1_000_000.0`
1818

1919
## 浮点数结构
2020
!!! note
@@ -52,7 +52,7 @@ julia> sin(NaN)
5252
NaN
5353
```
5454

55-
你可以指定某个位数的浮点数对应的无穷、不是数
55+
你可以指定某个位数的浮点数对应的无穷、不是数”:
5656
```julia-repl
5757
julia> typeof(Inf32)
5858
Float32
@@ -61,7 +61,7 @@ julia> typeof(NaN32)
6161
Float32
6262
```
6363

64-
同时需注意的是,`-0.0``0.0` 是不同的
64+
另外需要注意的是,在浮点数标准中 `-0.0``0.0` 是不同的
6565
```julia-repl
6666
julia> -0.0
6767
-0.0

docs/basic/function.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 函数
2-
函数 `Function` 是一个特殊的超类型,它的子类型的实例通过关键字 `function` 定义
2+
**函数**(function)是可重复调用的代码块,通过关键字 `function` 定义。在 Julia 中,`Function` 是所有函数类型的超类型。
33

44
## 基本格式
55
```jl
@@ -12,8 +12,7 @@ end
1212
函数名(参数1, 参数2) = 表达式
1313
```
1414

15-
最后的 `return` 可以不写,但可能造成阅读困难。
16-
若不写返回值,则返回 [`nothing`](little_types.md#无)
15+
最后的 `return` 可以省略,但显式写出有助于阅读。若不写返回值,则返回 [`nothing`](little_types.md#无)
1716

1817
函数可以直接或间接地调用自身,这称为递归。
1918
例如,你可以选择用递归方法计算 Fibonacci 数列:
@@ -40,7 +39,7 @@ ERROR: MethodError: no method matching foo(::Bool)
4039
```
4140

4241
参数类型声明**通常对性能没有影响**,在 Julia 中声明参数类型的最常见原因是
43-
* **派发**[方法](method.md) 中所述,对于不同的参数类型,你可以有不同版本(「方法」)的函数,在这种情况下,参数类型用于确定调用哪个版本的函数
42+
* **派发**[方法](method.md) 中所述,对于不同的参数类型,你可以有实现不同的函数(称为“方法”),在这种情况下,参数类型用于确定调用哪个版本的函数
4443
* **正确性** 函数只为某些参数类型返回正确的结果
4544
* **清晰性**
4645

docs/basic/hello.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ julia> #= 多行注释
1515
任何东西。
1616
=#
1717
18-
julia> # 如果你发现除了新的一行以外什么都没显示,说明您的操作正确
18+
julia> # 如果你发现除了新的一行以外什么都没显示,说明你的操作正确
1919
2020
```
2121

docs/basic/little_types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ julia> pair.second
6868
2
6969
```
7070

71-
注意不要将元组与对搞混
71+
注意不要将元组与对搞混:元组用整数索引访问任意位置的元素,而 `Pair` 是固定的二元对,主要用于构建字典或表达二元映射关系。
7272

7373
## 共用
7474
可以使用 `Union{Type1, Type2...}` 声明一个新[类型](../advanced/typesystem.md),它的实例可以取 `Type1``Type2` 等等中任一个。

docs/basic/loop.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# 循环
2-
循环用于在指定条件下重复执行指定代码。
3-
同样地,你也可以尝试举些例子、画流程图方便理解。
2+
循环用于在指定条件下重复执行指定代码。你可以尝试举些例子或画流程图来加深理解。
43

54
## while
65
`while` 循环的语法格式是:
@@ -90,7 +89,7 @@ while !escape
9089
end
9190
```
9291

93-
这里设置变量 `escape` 存储 `s == "quit"` 验证结果确实是实用的方法
92+
通过设置变量 `escape` 来记录退出条件是否成立,是一种常见且实用的写法
9493

9594
它也可以改为
9695
```jl

docs/basic/range.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ julia> collect(1.7:4.3)
2424
不建议让填入的参数满足 `start > stop`
2525

2626
## StepRange
27-
使用语法糖 `start:step:stop` 或调用 `UnitRange(start, step, stop)` 可以生成一个从 `start``stop`,步长为 `step` 的范围。
27+
使用语法糖 `start:step:stop` 或调用 `StepRange(start, step, stop)` 可以生成一个从 `start``stop`,步长为 `step` 的范围。
2828
```julia-repl
2929
julia> st = 20:7:40 # 自行修复 `stop` 值
3030
20:7:34

docs/basic/statement.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ if 条件
2424
end
2525
```
2626

27-
这里的**条件**statement)是一个表达式。
27+
这里的**条件**condition)是一个表达式。
2828

2929
与一些语言不同,Julia 中条件的值必须是 `Bool` 类型的实例,也就是 `true``false` 之一。
3030

@@ -39,7 +39,7 @@ end
3939
```
4040

4141
## elseif
42-
你可以将 `else``if` 合并,并并入同一层中
42+
你可以将 `else``if` 合并,并入同一层中:
4343
```julia
4444
if 条件1
4545
若条件1为真时执行
@@ -91,7 +91,7 @@ stat || content
9191
```
9292

9393
## 底层说明
94-
CPU 可能进行会分支预测 [^2]
94+
CPU 可能会进行分支预测。[^2]
9595

9696
## 练习
9797
- 只通过条件-分支结构,输入整数 `a``b``c`,然后输出它们中的最小值

docs/basic/string.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -118,15 +118,15 @@ julia> raw"\\"
118118
* `\"` => `"`
119119
* `\'` => `'`
120120
* 标准 C-escape 序列
121-
* `\0` NUL
122-
* `\a`
123-
* `\b`
124-
* `\t`
121+
* `\0` NUL(空字符)
122+
* `\a` 响铃
123+
* `\b` 退格
124+
* `\t` 水平制表符
125125
* `\n` 换行
126-
* `\v`
127-
* `\f`
128-
* `\r`
129-
* `\e`
126+
* `\v` 垂直制表符
127+
* `\f` 换页
128+
* `\r` 回车
129+
* `\e` 转义字符(ESC)
130130
* `\u` + 1~4 位 16 进制数
131131
* `\U` + 1~8 位 16 进制数
132132
* `\x` + 1~2 位 16 进制数

0 commit comments

Comments
 (0)