本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- SymPy
- 技術文件撰稿者：
- Soumi7
- 專案名稱：
- docstring 的一致性 - Sympy 說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
摘要：
Sympy 說明文件和先前作品的狀態：
SymPy 製作官方格式指南已完成工作。
Lauren Glattly 的 GSoD 專案為 SymPy docstring 建立了風格指南，請參閱 SymPy 說明文件格式指南。
我們已編輯 Special 子模組和 solvers.py 檔案中的 docstring，以便一致遵循新版樣式指南的規範
程式碼庫中的所有其他 docstring 仍須按照新的樣式指南進行編輯。
建議的工作：
SymPy 中的大部分 docstring 仍未遵循最新的樣式指南。這個專案的目標是更新整個 SymPy 中的 docstring，以便遵循本指南。
我與導師討論了專案，以下是討論的連結。
我們決定，在 sympy 程式碼集中編輯 docstring 以符合最新樣式指南是一項大工程，因此專案應限於此。
我會在這個專案中實作新指南，更新現有的 docstring，同時收集並解決其他不一致之處，例如用語或術語。
您可以稍後變更或決定現有子區段的順序，也可以將其視為另一項工作。
新增更多範例和參數部分，說明將不同值傳遞至參數時，結果會有所差異。
繼續在棘手問題和陷阱下，加入棘手的例子。
貢獻： - #17887：處理問題 #17887：在 Special 子模組中新增缺少的 docstring 部分。我已在 L 編輯的 Specials 子模組中，針對部分函式新增缺少的「參數和範例」部分。Glattly 遵循最新的樣式指南，並可做為日後 docstring 的範本。
以下是我合併的 PR 連結：https://github.com/sympy/sympy/pull/19334
- #19591：問題 #19591 用於追蹤「說明文件樣式」指南。我依照最新樣式指南新增了 PR 內容，以便編輯 core.sympify docstring。我已針對不同參數的使用方式新增結構化說明和範例。
以下是 PR 連結：https://github.com/sympy/sympy/pull/19613
專案目標
時間表 8 月 17 日前：
- 繼續為機構貢獻心力。
- 您可以更熟悉使用者說明文件及目前的症狀版本。
- 瞭解實作專案時有用的技巧。
社群連結：(2020 年 8 月 17 日至 9 月 13 日)
- 設置溝通管道和時間 (考量時差)。
- 精進目標，並為雙方設定期望。
- 討論模組的更新順序。
- 確定編輯模組的順序，讓這些模組遵循最新的 docstring 樣式指南。
文件提交期間(2020 年 9 月 14 日至 11 月 30 日)：
設定每週要達成的目標，最好每週更新一個模組或子模組的 docstring，甚至更多。
針對這些單元，我的主要目標是加入缺漏的部分，並調整文件字串結構，以遵循最新的樣式指南。這包括示範將不同值傳遞至參數時，所獲得的結果。所有棘手的輸出內容都必須新增至「Gotchas and Pitfalls」專區。
第 1 週 ( 9 月 14 日 - 9 月 21 日)：核心
第 2 週 (9 月 22 日 - 9 月 29 日)：函式：組合子模組
第 3 週 (9 月 30 日 - 10 月 6 日)：函式
第 4 週 (10 月 7 日 - 10 月 14 日)：Simplify、Crypto
第 5 週 (10 月 15 日至 21 日)：Diophantine
第 6 週 (10 月 22 日 - 10 月 29 日)：Holonomic :Operations 子模組
第 7 週 (10 月 30 日 - 11 月 7 日)：積分單元(integrals.integrals)，使用 Meijer G 函式計算積分
第 8 週 (11 月 8 日 - 11 月 15 日)：物理行為、函式位於「類別」模組結尾、程式碼產生模組、子模組特別
第 9 週 (11 月 16 日 - 11 月 23 日)：物理、函式在「類別」模組結尾、程式碼產生模組、子模組特別
第 10 週 (11 月 24 日 - 11 月 30 日)：「Gotchas and Pitfalls」部分
2020 年 11 月 30 日至 12 月 5 日 18:00 (世界標準時間)：提交最終專案和撰寫報告
2020 年 12 月 3 日至 10 日 18:00 (世界標準時間) ：提交成功的專案，以及與導師合作的經驗
在與導師進一步討論後，您可以變更這裡提到的模組順序。
根據導師的建議，我會先專注於更新較容易更新的模組，然後再處理複雜的模組。
為什麼我適合負責這個專案？
我認為自己是這個專案的合適人選，因為我曾撰寫電腦科學技術文章，也熟悉 Git 和 GitHub。
我已提交 PR，將說明文件更新為 sympy 的最新樣式指南，且已成功合併，因此我對工作流程和定期貢獻感到有信心。
一開始貢獻內容時，我遇到一些錯誤。我終於習慣在提交變更前執行測試並建構文件，因為這非常重要。
我很願意參與這項專案，也很期待。