Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Documentation of complicated options

未关闭
  • 哪里不对？
#5 7 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
停滞
领域
data-visualization, documentation

调研方向

首先查看 plot 文档、现有测试和 gallery 示例，尤其是 issue 中提到的 quoted-line、decorated-line、segmentation、front、custom-symbol、error-bar 和 vector-attribute 相关材料。完成标准是创建带有说明性插图的相互链接的详细页面，并将它们连接到相关模块文档和一个 HOW-TO 条目。

由索引模型根据 Issue 内容生成。

描述

The plot module is very powerful and very complicated to fully understand. There is an ocean of complexity between specifying how to plot a circle and how to plot a quoted line. The circle only has size, color, and pen to worry about, while for the quoted line we have six directives that determine where the text will be placed, then up to 20 modifiers to control various aspects of the result, from fonts to alignments to text being placed. Decorated lines are simpler in that there are only 8 modifiers to worry about. The segmentation option (-F) is another plot option that I think is extremely difficult to penetrate without more explanations in the form of examples. The error bar option -E, which includes box-and-whisker specifications, could also need a simple plot to explain the moving parts. There are probably others.

We actually have many examples of these options spread across our tests and gallery. However, I do not think we want to add page-size plots needed to fully cover quoted lines directly in the plot documentation. My proposal is therefore this:

Have more of a teaser figure as a heading for quoted lines and similar complicated options. This has been implemented. Then, there should be a link to a separate page for more details, similar to how we punt off the full explanation for all the modifiers related to vectors. I think the same applies to decorated lines, segmentation, and probably fronts. And custom symbols. We have an appendix on the custom symbol macro but very few pictures. The simpler stuff like error bars can fit in a small figure beneath that option.

The new pages should also form the backbone of another entry to the documentation that does not go through the modules. We have talked about this before as well. E.g., maybe a HOW-TO page that lists various how-tos:

  • How to plot symbols?
  • How to draw lines?
  • How to plot polygons?
  • How to plot text?
  • How to plot grids?

etc. These would cross-link to the detailed pages and back to the corresponding modules. The modules would also link to the same pages. So whether you know you need to use plot of whether you just know you want to plot lines, in either case you will find eventually yourself on the same page discussing the details, with examples. I note the vector attribute page that explains all the modifiers is completely free of illustrations. I think with GMT, a picture really is worth a 1000 words, so there is much to do here. A competent GMT scripter could make many of these illustrations.

主要语言
没有语言数据
星标
7
派生
1
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

GenericMappingTools/gmt-examples 的其他 Issue

查看 GenericMappingTools/gmt-examples 的全部 Issue

相似的 Issue

更多 Data Visualization Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。