Skip to content

Commit bf62d50

Browse files
committed
polish
1 parent 7147026 commit bf62d50

14 files changed

Lines changed: 20 additions & 19 deletions

File tree

docs/advanced/module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Julia 中的**模块**(module)是一些互相隔离的可变工作空间,
88
## 标准模块
99
* `Core` 包含了语言*内置*的所有功能
1010
* `Base` 包含了绝大多数情况下都会用到的基本功能
11-
* `Main` 是顶层模块,当 julia 启动时,也是当前模块
11+
* `Main` 是顶层模块;当 Julia 启动时,它也是当前模块
1212

1313
## 当前模块
1414
在使用时,你需要搞清楚当前模块的位置。模块中的所有代码,若无特别标注,都是作用于当前模块的。

docs/basic/io.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ end
5454
```
5555

5656
## 包裹
57-
可以使用 `IOBuffer(s)` 将字符串包裹成 IO 形式
57+
可以使用 `IOBuffer(s)` 将字符串包裹成 IO 形式
5858
```julia-repl
5959
julia> io = IOBuffer("buf")
6060
IOBuffer(data=UInt8[...], readable=true, writable=false, seekable=true, append=false, size=3, maxsize=Inf, ptr=1, mark=-1)

docs/basic/string.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Char
3030
`String` 是 Julia 内置的字符串,可以以 `Char` 的形式导出字符。
3131

3232
### 字面量
33-
字符串字面量通常使用一对双引号 `"` 定义,也可以使用一对 `"""` 表示多行字符串
33+
字符串字面量通常使用一对双引号 `"` 定义;若需要书写多行内容,也可以使用三引号 `"""..."""`
3434
```julia-repl
3535
julia> s = "猫猫"
3636
"猫猫"

docs/knowledge/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040

4141
更好的解决方案是「管道」。
4242

43-
Julia 提供了 [`Pipe`](../advanced/io.md) 方便操作;在命令行中,使用 `A | B`
44-
这会在内存创建一个管道,然后两个程序被同时启动。程序 A 每次要输出被重定向到这个管道中,而这个管道本身不会存储数据(其实有一个很小的缓冲区)。在 B 读取之前,A 的输出操作会被阻塞,等到 B 把数据读入以后,A 的输出才能继续进行。这样优美地解决了上述的问题,没有磁盘 IO 操作,两份代码同时运行,也没有额外消耗很多的内存储存中间结果
43+
Julia 提供了 [`Pipe`](../advanced/io.md) 便于操作;在命令行中可使用 `A | B`
44+
这会在内存中创建一个管道,并同时启动两个程序。A 的输出会被写入该管道;由于管道缓冲区很小,在 B 尚未读取时,A 的写入会暂时阻塞,等 B 读走数据后再继续。这样就避免了中间文件和额外磁盘 IO,也能让两段程序并发执行,同时减少中间结果的内存占用。
4545

4646
## 命名管道
4747
有时候我们不只是要把一个程序的输出重定向到另一个的输入。例如将 A 的输出重定向到 B 的输入,B 的输出重定向到 A 的输出,这个时候用上文提到的普通管道就无能为力了。而重定向到文件,又无法让两个程序同时运行。这个时候就需要一个长得像文件的管道——命名管道。

docs/knowledge/git.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ test.jl
6767
```
6868

6969
## 托管平台
70-
可以使用基于 git 的代码托管平台远程存储(并可分享)你的代码。最常见的平台是 [Github](github.md)
70+
可以使用基于 Git 的代码托管平台远程存储(并分享)你的代码。最常见的平台是 [GitHub](github.md)
7171

7272
## 使用技巧
7373
可以在 <https://www.conventionalcommits.org/zh-hans/v1.0.0/> 找到一个提交信息的非官方规范。

docs/knowledge/github.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Github 使用基础
1+
# GitHub 使用基础
22
## 关于
3-
Github 是当前使用最广泛的 [git](git.md) 平台
3+
GitHub 是当前使用最广泛的 [Git](git.md) 代码托管平台
44

5-
Github 主站:<https://github.com>
5+
GitHub 主站:<https://github.com>
66

77
## 账户
88
按照网站提示即可完成注册。
99

10-
您可以直接使用 `/login``/logout` 路径登录登出。应特别注意账号安全,因为很多平台可能都支持与 github 账户进行绑定
10+
您可以直接使用 `/login``/logout` 路径进行登录与登出。应特别注意账号安全,因为许多平台都支持与 GitHub 账户绑定
1111

1212
## 参阅
1313
- <https://discourse.juliacn.com/t/topic/6806>

docs/knowledge/latex.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
## LaTeX
22
LaTeX 是一种渲染文档、数学公式所用的表达语言(当然,一些 Tex 宏包还支持有机化学等)。
33
通常使用的是它的一部分,[KaTeX](https://katex.org/),主要用于表达数学公式。
4-
在 julia-markdown 中,它的嵌入可以采用传统的美元,即一对 `$ $`,也可以使用一对 ``` `` `` ```
4+
5+
在 Julia Markdown 中,数学公式可以采用传统的美元符号定界(如一对 `$...$`),也可以使用反引号定界(如一对 ``` `` `` ```)。
56

67
## 参阅
78
- [入门参考](https://docs.net9.org/basic/latex/)

docs/knowledge/licenseknowledge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## 关于
33
对于每个开源项目,应该提供一个许可证(不提供并让别人问也是一种选择,但不提倡)。
44

5-
Github 上使用率最高的五个许可证是 MIT、Apache 2.0、GPL 2.0、GPL 3.0 和 bsd-3-clause[^1],而文本通常使用[CC族协议](https://creativecommons.org/licenses/)
5+
GitHub 上使用率最高的五个许可证是 MIT、Apache 2.0、GPL 2.0、GPL 3.0 和 BSD-3-Clause[^1];而文档文本通常使用 [CC 系列协议](https://creativecommons.org/licenses/)
66

77
## 参阅
88
- [经典老文:如何选择开源许可证](https://www.ruanyifeng.com/blog/2011/05/how_to_choose_free_software_licenses.html)

docs/knowledge/markdown.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Markdown
2-
Markdown 是一种被广泛使用的轻量级标记语言,它的大体规范相同,但在不同平台可能存在细节上的差异。如 Github 的 GFM (github-flavored markdown)、一个常用标准 [CommonMark](https://spec.commonmark.org/);而 Julia 的代码内文档等使用的规范是 [julia-markdown](https://docs.juliacn.com/latest/stdlib/Markdown/)
2+
Markdown 是一种被广泛使用的轻量级标记语言。它的总体规范相近,但在不同平台上常有细节差异,例如 GitHub 的 GFM(GitHub Flavored Markdown)与常用标准 [CommonMark](https://spec.commonmark.org/)Julia 代码内文档采用的规范可参见 [Julia Markdown](https://docs.juliacn.com/latest/stdlib/Markdown/)
33

44
一些 Markdown 变体允许嵌入 [LaTeX](latex.md) 的变体来表达数学公式。
55

docs/meta/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
本项目的一部分页面不会展现在侧边栏中,你会在一些链接处遇到它们。
2727

28-
讨论区可以在注册 [Github](../knowledge/github.md) 后使用。**不要吝啬你的反馈**:若某节难以理解、示例无法运行或与当前 Julia 行为不符,不妨在讨论区中指出,或给我提 [Issue](https://github.com/JuliaRoadmap/zh/issues/new)
28+
讨论区可以在注册 [GitHub](../knowledge/github.md) 后使用。**不要吝啬你的反馈**:若某节难以理解、示例无法运行或与当前 Julia 行为不符,不妨在讨论区中指出,或提交 [Issue](https://github.com/JuliaRoadmap/zh/issues/new)
2929

3030
内容来自贡献者与读者的持续修订。[在此阅读](https://github.com/JuliaRoadmap/zh/blob/master/CONTRIBUTING.md)如何贡献。
3131

0 commit comments

Comments
 (0)