帮助完善文档#

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

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

如果您没有发现文档本身有什么需要改进的地方，可以在 GitHub 中搜索 issue。

注意

在搜索与文档相关的 issue 时，请导航至 GitHub 标签，然后选择 Component: Documentation，或者在“Search all labels”窗口中搜索 Documentation。

参见 示例搜索。

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

注意

许多仅文档的更改可以直接在 GitHub Web 界面中进行，方法是单击文档页面右上角的 Edit this page。 这将处理为您创建 fork 和 pull request。

click on edit this page

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

edit file in 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 包本身中的函数和方法的文档字符串。 例如，要编辑 pyarrow.Array，您需要编辑 docstrings 在 arrow/pyarrow/array.pxi。

    C++ 也是如此。

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

    另请参阅

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

Cookbooks 有他们自己的仓库 apache/arrow-cookbook 并且能够被分别克隆和构建。