文档贡献

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

如果您是 Arrow 用户，并且发现某些文档不完整或不准确，请与社区分享您的经验。

如果您在文档中没有发现需要改进的地方，可以在 GitHub 中搜索相关问题。

注意

搜索与文档相关的问题时，请导航至 GitHub 标签 并选择 **Component: Documentation（组件：文档）** 或在“搜索所有标签”窗口中搜索 **Documentation（文档）**。

请参阅 搜索示例。

改进文档也是一种很好的方式，可以在无需大量本地开发环境设置的情况下获得提交和审查流程的经验。

注意

许多仅涉及文档的更改可以直接在 GitHub Web 界面中进行，方法是单击文档页面右上角的 **Edit this page（编辑此页面）**。这将自动为您创建一个分支并提交拉取请求。

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

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

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

如果您希望在本地构建文档，请遵循 构建文档 中的详细说明。

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

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

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

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

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

• 语言文档

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

  参考文档

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

  C++ 也是类似的。

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

  另请参阅

  要阅读有关 R 文档的更多信息，请访问

  • R 包手册中的对象文档

  • roxygen2

  • pkgdown

**教程** 有其自己的存储库 apache/arrow-cookbook，可以单独克隆和构建。