帮助编写文档

为项目做出贡献的一个好方法是改进文档。

如果您是 Arrow 用户，并且发现某些文档不完整或不准确，请与社区分享您辛苦获得的知识。

如果您没有在文档本身中找到需要改进的地方，您可以搜索 GitHub 中的 Issue。

注意

当搜索与文档相关的 Issue 时，请导航到 GitHub 标签 并选择 **组件：文档** 或在“搜索所有标签”窗口中搜索 **文档**。

请参阅 示例搜索。

文档改进也是在不需要大量本地开发环境设置的情况下，获得我们提交和审查流程经验的好方法。

注意

许多仅涉及文档的更改可以直接在 GitHub 网页界面中进行，方法是点击文档页面右上角的 **编辑此页面**。这将为您处理创建分支和 Pull Request。

在 GitHub 中文件的右上角点击笔图标。

现在您可以在 GitHub 中编辑文件。

您也可以构建整个项目，在您的分支上进行本地更改，然后以这种方式创建 PR。但这绝不优于直接通过 GitHub 编辑。

如果您希望在本地构建文档，请按照 构建文档 中的详细说明进行操作。

在哪里找到要更改的正确文件？

大多数文档位于 Arrow 库的 docs/source 中。Source 文件夹包含

• C++ 文档 部分：docs/source/cpp。

• 开发 部分：docs/source/developers。

• 规范和协议 部分：docs/source/format。

• 语言文档

  C (GLib)、Java、JavaScript 和 Python 文档位于以语言命名的文件夹中，例如：docs/source/c_glib。

  参考文档

  要编辑 Python 的 API 参考文档，您需要编辑 pyarrow 包本身中函数和方法的 docstrings。例如，要编辑 pyarrow.Array，您需要编辑 docstrings 在 arrow/pyarrow/array.pxi 中。

  C++ 也是类似的。

• arrow R 包（在 pkgdown 网站上发布，地址为 arrow.apache.org/docs/r/) 的文档位于 r/ 子目录中。

  另请参阅

  要详细了解 R 中的文档，请访问

  • R 包书籍中的对象文档

  • roxygen2

  • pkgdown

食谱 有自己的存储库 apache/arrow-cookbook，可以单独克隆和构建。