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

完善按功能分类的GMT模块列表 #440

Closed
1 task done
Tracked by #371
core-man opened this issue Jun 20, 2021 · 5 comments · Fixed by #495
Closed
1 task done
Tracked by #371

完善按功能分类的GMT模块列表 #440

core-man opened this issue Jun 20, 2021 · 5 comments · Fixed by #495
Assignees
Labels

Comments

@core-man
Copy link
Member

core-man commented Jun 20, 2021

最早提出于 #439 (comment)

Do we want to update the following tables based on https://docs.generic-mapping-tools.org/latest/modules.html#session-management in another PR later?

我们需要重新整理一下 GMT 模块(按功能分类) 列表,这里包含的模块也不全。

@core-man
Copy link
Member Author

core-man commented Jul 30, 2021

GMT 官方的按功能分类分得更加细,而中文手册分得比较粗。例如,

  • 中文手册将所有绘图模块都放在了绘图相关模块,其中segyzsegy 在官方手册里与 segy2grd 一同放在 SEGY 分类下。
  • 2D 数据处理里模块众多,不熟悉这些模块的用户想查找具有某功能的模块较为费事。将他们分为滤波、网格化等等更有好一点
  • 地震学的四个模块现在放在绘图相关模块分类中,但是其实这些只有地震学专业采用,似乎单独一个表格比较有好

我个人觉得较细的分类更加友好一点,因此想在官方分类的基础将模块细分一下。如果没有意见,我会逐渐提交 PR。

@seisman
Copy link
Member

seisman commented Jul 30, 2021

我个人觉得较细的分类更加友好一点,因此想在官方分类的基础将模块细分一下。如果没有意见,我会逐渐提交 PR。

OK。在开始细分之前,我建议对现有的分类先做一些简化,主要是两点:

  1. 使用 Sphinx 的 simple table 而非 grid table (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables)
  2. 由于列表很长,所以建议给每个分类建一个 label,然后在这里使用 :ref: 语法建一个分类的列表

image

@core-man
Copy link
Member Author

OK。在开始细分之前,我建议对现有的分类先做一些简化,主要是两点:

  1. 使用 Sphinx 的 simple table 而非 grid table (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables)
  2. 由于列表很长,所以建议给每个分类建一个 label,然后在这里使用 :ref: 语法建一个分类的列表

Sound good to me~

@seisman
Copy link
Member

seisman commented Jul 30, 2021

可以先发一个小PR看看效果,以免效果不好浪费时间。

@core-man
Copy link
Member Author

Okay.

@seisman seisman unpinned this issue Jul 31, 2021
@ZMAlt ZMAlt closed this as completed Oct 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants