Skip to content

Commit 48e082b

Browse files
committed
docs: fix
1 parent 15f9a6e commit 48e082b

9 files changed

Lines changed: 46 additions & 42 deletions

File tree

docs/basic/misc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,7 @@ search: aaa readavailable bytesavailable AbstractArray AbstractRange
5757

5858
这种“前面紧跟”规则是预设的,也可以改变,可参阅[关于代码文档的更多内容](https://docs.juliacn.com/latest/manual/documentation/#man-documentation)
5959

60+
docstring 支持 Markdown 格式。
61+
6062
## 变量引用机制
6163
你可能已经意识到了,一些函数(通常末尾带 `!`)可以改变变量的值,而一些类型的实例却总是无法被改变的。关于这个,请参阅[语言进阶 - 变量引用机制](../advanced/varref.md)

docs/basic/setup_environment.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
!!! tips
3838
一般地,可以搜索 `julia playground` 寻找可用的在线平台。
3939

40-
## 说明
40+
## 获取说明
4141
### 版本选择
4242
通常建议选择最新稳定版本,或者对稳定性有需求可以选择**长期维护版**(long-time support)。
4343
* [关于选择:选择 Stable 还是 LTS 还是 nightly](https://docs.juliacn.com/v1/manual/faq/#Do-I-want-to-use-the-Stable,-LTS,-or-nightly-version-of-Julia?)
@@ -150,5 +150,9 @@ PS C:\Users\username>
150150

151151
如果你想在打开 REPL 后运行指定文件中的代码,可以使用 `include("文件路径")`,更多在[](../basic/misc.md#加载代码)阅读。
152152

153+
## 其它配置
154+
* 关于包服务器镜像的配置,参阅[包的简介 - 包服务器](../workflow/introduction.md#包服务器)
155+
* [关于 Julia 的环境变量](https://docs.juliacn.com/latest/manual/environment-variables/)
156+
153157
[^1]: https://discourse.juliacn.com/t/topic/159
154158
[^2]: [USTCLUG Mirror 已经停止镜像](https://servers.ustclug.org/2023/07/julia-removal/)

docs/packages/downloads.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Downloads
2-
Downloads 是一个[标准库](stdlib.md),基于 `Curl`,用于满足基本的[爬虫](../knowledge/spider.md)需求。
2+
Downloads 是一个[标准库](../workflow/stdlib.md),基于 `Curl`,用于满足基本的[爬虫](../knowledge/spider.md)需求。
33
Downloads 支持的各项设置较少,如需更多设置可使用 [HTTP](http.md)
44

55
## request
@@ -19,21 +19,20 @@ request(url;
1919
```
2020

2121
```julia-repl
22-
julia> io=IOBuffer()
22+
julia> io = IOBuffer()
2323
IOBuffer(data=UInt8[...], readable=true, writable=true, seekable=true, append=false, size=0, maxsize=Inf, ptr=1, mark=-1)
2424
25-
julia> Downloads.request("http://httpbin.org/user-agent";output=io)
26-
Response("http", "http://httpbin.org/user-agent", 200
27-
...
25+
julia> Downloads.request("http://httpbin.org/user-agent"; output=io)
26+
Response("http", "http://httpbin.org/user-agent", 200, "HTTP/1.1 200 OK", ...)
2827
2928
julia> String(take!(io))
30-
"\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0{\n \"user-agent\": \"curl/7.73.0 julia/1.6\"\n}\n"
29+
"{\n \"user-agent\": \"curl/8.6.0 julia/1.11\"\n}\n"
3130
```
3231

3332
## download
3433
建议将下载作为它的唯一功能,其它功能用 `request` 实现
3534
```julia-repl
36-
julia> fio=open("D:/foo.png","w")
35+
julia> fio = open("D:/foo.png","w")
3736
IOStream(<file D:/foo.png>)
3837
3938
julia> Downloads.download("http://httpbin.org/image/png",fio);

docs/packages/markdown.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
# Markdown
2-
Markdown 是一个[标准库](stdlib.md),用于解析和导出 [Markdown 格式](../knowledge/markdown.md)
2+
Markdown 是一个[标准库](../workflow/stdlib.md),用于解析和导出 [Markdown 格式](../knowledge/markdown.md)
33

4-
## 基础使用
4+
使用示例如下:
55
```julia-repl
6-
julia> m=md"""
6+
julia> using Markdown
7+
8+
julia> m = md"""
79
# 标题
810
1. 内容
9-
""" # 也可用@md_str、parse
11+
""" # 也可用 @md_str、parse
1012
标题
1113
≡≡≡≡
1214
1315
1. 内容
1416
15-
julia> html(m) # 以html形式导出
17+
julia> html(m) # 以 html 形式导出
1618
"<h1>标题</h1>\n<ol>\n<li><p>内容</p>\n</li>\n</ol>\n"
1719
18-
julia> latex(m) # 以纯latex形式导出
20+
julia> latex(m) # 以纯 latex 形式导出
1921
"\\section{标题}\n\\begin{itemize}\n\\item[1. ] 内容\n\n\\end{itemize}\n"
2022
```
2123

docs/packages/pkg.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/packages/uuids.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# UUIDs
22
## 介绍
33
**通用唯一辨识符**(UUID,Universally Unique Identifier)是用于给任意物品提供*唯一*辨识符的设计。
4-
标准可参考 [RFC 4122](https://www.ietf.org/rfc/rfc4122)
4+
5+
UUID 的标准可参考 [RFC 4122](https://www.ietf.org/rfc/rfc4122)
56

67
## UUID 类型
78
```julia-repl

docs/workflow/classify.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## 总体
33
[编译你的 Julia 包 - PackageCompiler](https://github.com/JuliaLang/PackageCompiler.jl)\
44
[Julia 调试器 - Debugger](https://github.com/JuliaDebug/Debugger.jl)\
5-
[在运行的 Julia 会话中自动更新函数定义 - Revise](../../packages/revise.md)\
5+
[在运行的 Julia 会话中自动更新函数定义 - Revise](../packages/revise.md)\
66
[性能测试 - Profile](https://docs.juliacn.com/latest/manual/profile/)
77

88
## 统计学
@@ -14,17 +14,17 @@
1414
[多项式操作 - Polynomials](https://github.com/JuliaMath/Polynomials.jl)
1515

1616
## 数据可视化
17-
[强大便利的 Julia 可视化和数据分析工具 - Plots](../../packages/plots.md)\
18-
[在 GPU 上高性能绘图 - Makie](../../packages/makie.md)\
17+
[强大便利的 Julia 可视化和数据分析工具 - Plots](../packages/plots.md)\
18+
[在 GPU 上高性能绘图 - Makie](../packages/makie.md)\
1919
[Plots 的统计绘图方案 - StatePlots](https://github.com/JuliaPlots/StatsPlots.jl)
2020

2121
## 符号计算
2222
[快速,现代的 CAS - Symbolics](https://github.com/JuliaSymbolics/Symbolics.jl)
2323

2424
## 数据工具
2525
[*网站 Julia DB](https://juliadb.org/)\
26-
[Julia 中的内存表格数据 - DataFrames](../../packages/dataframes.md)\
27-
[处理 CSV 和其他分隔文件 - CSV](../../packages/csv.md)\
26+
[Julia 中的内存表格数据 - DataFrames](../packages/dataframes.md)\
27+
[处理 CSV 和其他分隔文件 - CSV](../packages/csv.md)\
2828
[对流数据执行在线计算 - OnlineStats](https://github.com/joshday/OnlineStats.jl)\
2929
[查询、文件 IO 和可视化功能 - Queryverse](https://www.queryverse.org/)\
3030
[图论处理 - JuliaGraphs](https://juliagraphs.github.io/)\

docs/workflow/develop.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# 包开发
22
## 流程
3-
通常来说,包的全部数据应该是一个 [git](../../meta/tools/git.md) 仓库,置于 github(或其它保证长期稳定的服务器)中,建议添加一份[许可证](../../knowledge/licenseknowledge.md)。每次更新时应在本地操作再推送到远程仓库并注册更新(若需要)
3+
通常来说,包的全部数据应该是一个 [git](../meta/tools/git.md) 仓库,置于 github(或其它保证长期稳定的服务器)中,建议添加一份[许可证](../knowledge/licenseknowledge.md)。每次更新时应在本地操作再推送到远程仓库并注册更新(若需要)
44

55
## 结构生成
66
设置好路径后,可以在包管理器模式下使用 `generate foo` 生成基本框架。
77

88
[相对路径](../advanced/filesystem.md#路径) `./foo` 处生成一个目录,包含包的基本结构:
9-
- `src/foo.jl`,包含一个[模块](../../advanced/module.md)的基本结构
9+
- `src/foo.jl`,包含一个[模块](../advanced/module.md)的基本结构
1010
- `Project.toml`,包含相关注册信息
1111

1212
也可以参照:
1313
- [官方提供的包示例](https://github.com/JuliaLang/Example.jl)
1414
- [包模板生成器](https://invenia.github.io/PkgTemplates.jl/stable/)
1515

1616
## Project.toml
17-
`Project.toml` 使用 [TOML 格式](../../knowledge/toml.md),数据中必须含有以下内容
17+
`Project.toml` 使用 [TOML 格式](../knowledge/toml.md),数据中必须含有以下内容
1818
- `name` 表示包名,应与模块名一致
19-
- `uuid` 一个独一无二的 UUID,可以使用 [UUIDs](../../packages/uuids.md) 生成
20-
- `version` 当前[版本](../../advanced/versionnumber.md)
19+
- `uuid` 一个独一无二的 UUID,可以使用 [UUIDs](../packages/uuids.md) 生成
20+
- `version` 当前[版本](../advanced/versionnumber.md)
2121
- `[deps]` 一个字典,包含 `基于的包名 = "它的UUID"`,后者可以通过查找对应仓库中填写的 `uuid` 项或其它调用了它的包中的 `[deps]` 项获取
2222
- `[compat]` 一个字典,包含 `包名 = "支持的版本"`,特别地,`julia` 项表示支持的 Julia 版本
2323
- [`extras``target` 的用途](https://discourse.juliacn.com/t/topic/6341/2)
@@ -45,7 +45,7 @@ PNGFiles = "0.3"
4545
`build` 失败,提示信息会在终端显示
4646

4747
## test
48-
该功能不是必要的;可参考 [Test 的使用](../../packages/test.md)
48+
该功能不是必要的;可参考 [Test 的使用](../packages/test.md)
4949

5050
## 手动测试
5151
`add` 命令允许参数是一个本地路径,从而在本地安装包,以模拟包环境。
@@ -85,7 +85,7 @@ Base.Math
8585
Julia 1.3 以后,`Artifacts` 可以用于将数据块与包捆绑在一起,甚至允许按需下载它们。优先选择 `Artifacts`,而不是试图通过路径,因为这是不可重定位的:一旦你的包被预编译,`@__DIR__` 的结果将被嵌入到预编译的包数据中,如果你试图分发这个包,它将试图在错误的位置加载文件
8686

8787
### Scratch
88-
Julia 1.5 以后,[Scratch](../../packages/scratch.md)提供了*临时空间*的概念,即包的可变数据容器。Scratch空间是为完全由包管理的数据缓存设计的,应该在包本身卸载时删除。对于重要的用户生成的数据,包应该继续写入到一个用户指定的路径,该路径不是由 `Julia``Pkg` 管理的
88+
Julia 1.5 以后,[Scratch](../packages/scratch.md)提供了*临时空间*的概念,即包的可变数据容器。Scratch空间是为完全由包管理的数据缓存设计的,应该在包本身卸载时删除。对于重要的用户生成的数据,包应该继续写入到一个用户指定的路径,该路径不是由 `Julia``Pkg` 管理的
8989

9090
### Preferences
9191
Julia 1.6 以后,`Preferences` 允许包读写首选项到顶级的 `Project.toml`。这些首选项可以在运行时或编译时读取,以启用或禁用包行为的不同方面(以前,包会将文件写入到它们自己的包目录中以记录由用户或环境设置的选项,但现在不鼓励该行为)

docs/workflow/stdlib.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# 标准库
22
[中文文档](https://docs.juliacn.com/latest/)侧边栏 `Standard Library` 处可以找到当前标准库找到列表。
3-
部分标准库是位于 `Base` 下的子[模块](../../advanced/module.md),部分标准库可能需要安装。
3+
部分标准库是位于 `Base` 下的子[模块](../advanced/module.md),部分标准库可能需要安装。
44

55
## 参阅
66
- [近来部分包被建议移出标准库的相关信息](https://discourse.juliacn.com/t/topic/6323)
77
- [What is a Julia standard library?](https://github.com/JuliaLang/julia/discussions/43116)
88

99
## 已有文档
10-
- [CRC32c - 同名校验算法实现](../../packages/crc32c.md)
11-
- [Dates - 日期与时间](../../packages/dates.md)
12-
- [Downloads - 基本爬虫需求](../../packages/downloads.md)
13-
- [Markdown - 同名格式的解析与导出](../../packages/markdown.md)
14-
- [Pkg - 包管理](../../packages/pkg.md)
15-
- [Random - 随机](../../packages/random.md)
16-
- [Sockets - 套接字](../../packages/sockets.md)
17-
- [TOML - 同名格式的解析和导出](../../packages/toml.md)
18-
- [Unicode - Unicode工具](../../packages/unicode.md)
19-
- [UUIDs - 通用唯一辨识符的生成](../../packages/uuids.md)
10+
- [CRC32c - CRC32c 校验算法实现](../packages/crc32c.md)
11+
- [Dates - 日期与时间](../packages/dates.md)
12+
- [Downloads - 基本爬虫需求](../packages/downloads.md)
13+
- [Markdown - Markdown 格式的解析与导出](../packages/markdown.md)
14+
- Pkg - 包管理<https://cn.julialang.org/Pkg.jl/dev/>
15+
- [Random - 随机](../packages/random.md)
16+
- [Sockets - 套接字](../packages/sockets.md)
17+
- [TOML - 同名格式的解析和导出](../packages/toml.md)
18+
- [Unicode - Unicode 工具](../packages/unicode.md)
19+
- [UUIDs - 通用唯一辨识符的生成](../packages/uuids.md)

0 commit comments

Comments
 (0)