参与文档贡献#

改进文档是为本项目做出贡献的绝佳方式。

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

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

注意

搜索与文档相关的问题时，请导航至 GitHub 标签页，然后选择 Component: Documentation，或者在“搜索所有标签”窗口中搜索 Documentation。

请参阅 搜索示例。

改进文档也是熟悉我们提交和审查流程的好方法，而无需进行大量的本地开发环境配置。

注意

许多仅涉及文档的更改可以直接在 GitHub 网页界面中完成，只需点击文档页面右上角的 Edit this page（编辑此页面）按钮即可。系统会自动为您处理 Fork 和提交 Pull Request 的流程。

click on edit this page

点击 GitHub 文件右上角的铅笔图标。#

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

    C++ 的情况类似。

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

    另请参阅

    如需详细了解 R 语言文档，请访问

Cookbooks（手册）拥有独立的仓库 https://github.com/apache/arrow-cookbook，可以单独克隆和构建。