Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

建议添加文档习惯 #1087

Open
ZMAlt opened this issue Jul 16, 2023 · 5 comments · May be fixed by #1216
Open

建议添加文档习惯 #1087

ZMAlt opened this issue Jul 16, 2023 · 5 comments · May be fixed by #1216

Comments

@ZMAlt
Copy link
Member

ZMAlt commented Jul 16, 2023

目前文档里类似:中括号是省略;尖括号是必须值,使用的时候要替换;等等这些,虽然有点通用默认的意思,但有些人真的没有这些意识。手册里貌似没有?我建议加一节说明

@seisman
Copy link
Member

seisman commented Jul 17, 2023

可以

@seisman
Copy link
Member

seisman commented Sep 17, 2023

加在哪里比较合适?

似乎第一次出现 []| 等符号是在这一章(https://docs.gmt-china.org/latest/basis/)。加在这一章的开头?

@ZMAlt
Copy link
Member Author

ZMAlt commented Sep 17, 2023

确实没什么好的位置。这个东西本质上还是从命令行来的,是不是可以放在 命令初探 的后面。title 定为 命令帮助 类似的,介绍几个内容

  1. 是给命令行语法,方括号尖括号什么的

  2. 给出 docs 模块的链接

  3. 我有一个 gmtcn docs 的脚本 https://github.com/ZMAlt/gmtcn ,我平时用的挺多的,如果觉得有用的话,可以链接一下。

@seisman
Copy link
Member

seisman commented Sep 17, 2023

是不是可以放在 命令初探 的后面。

算是个比较合适的位置。

3. 我有一个 gmtcn docs 的脚本 https://github.com/ZMAlt/gmtcn ,我平时用的挺多的,如果觉得有用的话,可以链接一下。

看上去不错。是否考虑迁移到 gmt-china 里维护?

@ZMAlt
Copy link
Member Author

ZMAlt commented Sep 18, 2023

是否考虑迁移到 gmt-china 里维护?

非常乐意,其实以前就想介绍下的,但担心大家看不上。

已经迁移 https://github.com/gmt-china/gmtcn 。后面会抹掉我个人的信息,请大家帮忙改进和维护。

@ZMAlt ZMAlt linked a pull request Sep 21, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants