帮助完善文档

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

如果您是 Arrow 用户，并且发现某些文档不完整或不准确，请与社区的其他人分享您来之不易的知识。

如果您在文档本身中没有发现可以改进的地方，您可以在 GitHub 上搜索相关 issue。

注意

当搜索与文档相关的 issue 时，请导航到 GitHub 标签页面，并选择 Component: Documentation，或在“搜索所有标签”窗口中搜索 Documentation。

请参阅搜索示例。

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

注意

许多只涉及文档的更改可以直接在 GitHub 网页界面上进行，只需点击文档页面右上角的 Edit this page 按钮。这个操作会自动为您创建 fork 和 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，您需要编辑 arrow/pyarrow/array.pxi 中的 docstrings。

  C++ 的情况与此类似。

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

  另请参阅

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

  • R packages 书中的对象文档

  • roxygen2

  • pkgdown

Cookbooks 有其自己的代码仓库 apache/arrow-cookbook，可以单独克隆和构建。