标签术语#
API 标签:示例中包含 API 参考的哪些内容?#
|
用例 |
|---|---|
主要或相关的情节组成部分 |
|
|
显著或非常清晰的组件使用 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
经常与 |
|
|
|
|
样式 |
|
当图表包含可教学的示例时使用这些标签 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
样式是通过满足某个条件以编程方式确定的 |
互动性 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
绘图类型 |
|
|
示例包含一个条形图 |
|
示例包含一条线图 |
|
示例包含一个饼图 |
|
示例包含一个极坐标图 |
|
示例包含一个3D图 |
|
示例包含一个直方图 |
|
|
|
|
结构标签:示例是什么格式?我们可以提供什么上下文?#
|
用例 |
|---|---|
|
level 指的是用户需要多少上下文/背景 |
|
概念是独立的、自包含的,只需要一个模块。 |
|
概念可能需要其他模块的知识,存在依赖关系 |
|
概念需要多个模块并且有依赖关系 |
|
它在这里的目的是什么? |
|
讲故事的典范 -- 构建视觉论点 |
|
|
|
只是为了好玩! |
|
好的展示示例 |
领域标签:哪些学科可能会持续寻求这个示例?#
试图在“谁拥有什么”之间划定界限是徒劳的,而这并不是域标签的重点。请参见下面的现有域标签列表。如果你没有找到你想要的,并且你认为它应该存在,可以考虑提出建议。
|
用例 |
|---|---|
|
这个例子对谁相关? |
|
|
|
|
|
|
|
|
|
内部标签:哪些信息对维护者或贡献者有帮助?#
这些标签应仅用于开发目的;因此请将它们单独添加在版本保护之后:
.. ifconfig:: releaselevel == 'dev'
.. tags:: internal: needs-review
|
用例 |
|---|---|
|
允许用户过滤掉像动画这样占用带宽的示例 |
|
允许文档贡献者轻松找到未标记的示例 |
|
包含已弃用的功能或概念的示例 |
|
需要对示例进行准确性或教学价值的审查 |
|
示例有一个未完成的待办事项 |
|
该示例应进行改进,拆分为多个示例,或重新格式化为教程或参考文档。 |