協助撰寫文件#

改善文件是為專案做出貢獻的好方法。

如果您是 Arrow 使用者，並且發現某些文件不完整或不準確，請與社群其他成員分享您辛苦習得的知識。

如果您沒有發現文件本身有任何需要改進的地方，您可以在 GitHub 中搜尋 issue。

注意

當搜尋與文件相關的 issue 時，請導航至 GitHub labels 並選擇 Component: Documentation，或在「Search all labels」視窗中搜尋 Documentation。

請參閱 搜尋範例。

文件改進也是在不需要大量本地開發環境設定的情況下，獲得提交和審閱流程經驗的好方法。

注意

許多僅限文件的更改可以直接在 GitHub 網頁介面中完成，方法是點擊文件頁面右上角的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 套件本身中的函式和方法的 docstring。例如，若要編輯 pyarrow.Array，您需要編輯 arrow/pyarrow/array.pxi 中的 docstrings。

    C++ 也是如此。

  • arrow R 套件的文件（發布在 pkgdown 網站 arrow.apache.org/docs/r/) 上）位於 r/ 子目錄中。

    另請參閱

    若要閱讀更多關於 R 文件的資訊，請造訪

Cookbook 有自己的儲存庫 apache/arrow-cookbook，可以單獨複製和建置。