本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- SymPy
- 技術文件撰寫者：
- Soumi7
- 專案名稱：
- 文件字串的一致性 - Sympy 說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
摘要：
符號文件和先前作業的狀態：
建立 SymPy 官方樣式指南的作業已完成。
Lauren Glattly 的 GSoD 專案針對 SymPy 文件字串建立了樣式指南，您可以在 SymPy 說明文件樣式指南中找到。
已編輯特殊子模組和 Resolvers.py 檔案中的 docstring 檔案，以持續遵循新樣式指南的規範
系統仍在編輯程式碼集中的所有其他 docstring 內容，以符合新的樣式指南。
提議的作業：
SymPy 中大部分的 docstring 仍不符合最新的樣式指南。這項專案的目標是更新 SymPy 內的 docstring，以遵循本指南。
我和導師討論這項專案以下是討論內容的連結。
他們決定為了遵循最新樣式指南，編輯整個符號程式碼集內的 docstring 是項艱鉅的工作，而且專案內容應該有限。
這項專案包含導入新指南來更新現有文件字串，以及收集和解決其他不一致的問題，例如語言使用或字詞。
現有子區段的順序可以在稍後變更或決定，或者做為獨立工作。
透過新增範例以及新增參數部分，說明將不同值傳送至參數時的結果差異。
繼續在「難免」和「陷阱」一節中加入棘手範例。
捐款： - #17887 ：處理問題 #17887：在特殊子模組中新增缺少的 docstring 區段。我在 L 編輯的「特殊」子模組函式中，新增了缺少的「參數與範例」部分。樂於遵循最新格式指南，並做為未來文件字串的參考模型。
以下是我合併的 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 日 - 2020 年 11 月 30 日)：
設定每週達成的目標，最好每週或更長時間地更新一個單元或子模組的文件字串。
所有這些模組的主要目標是新增遺漏的區段，並且根據最新樣式指南重新建構文件字串。這包括示範將不同值傳遞至參數時所產生的不同結果。所有棘手的輸出內容都會新增至「Gotchas」和「Ptfalls」章節。
第 1 週 ( 9 月 14 日 - 9 月 21 日)：核心
第 2 週 (9 月 22 日 - 9 月 29 日)：函式：子模組組合
第 3 週 (9 月 30 日至 10 月 6 日)：函式
第 4 週 (10 月 7 日至 10 月 14 日)：簡化、加密貨幣
第 5 週 (10 月 15 日 - 10 月 21 日)：二氧化氮
第 6 週 (10 月 22 日至 10 月 29 日)：Holonomic :Operations 子模組
第 7 週 (10 月 30 日至 11 月 7 日)：Integrals Module(integrals.integrals)、使用 Meijer G-Functions 計算積分
第 8 週 (11 月 8 日至 11 月 15 日)：物理、類別單元末尾的函式、程式碼產生單元、子模組特別
第 9 週 (11 月 16 日 - 11 月 23 日)：物理、類別單元末尾的函式、程式碼產生單元、子模組特別模組
第 10 週 (11 月 24 日至 11 月 30 日)：「Gotchas」與「Ptfalls」
世界標準時間 2020 年 11 月 30 日至 12 月 5 日 18:00：最終提交專案及報告編寫
2020 年 12 月 3 日 - 10 日 18:00 (世界標準時間)：提交專案成功，以及與導師合作的經驗
與導師進一步討論後，可以變更這裡提及的單元順序。
根據導師的建議，我會先專注於更新較容易更新的模組，然後再處理複雜的模組。
為什麼我是這項專案的負責人？
我過去曾運用電腦科學技術寫作，而且相當熟悉 Git 和 GitHub，因此我認為自己是這項專案的負責人。
由於我提交 PR 後，便將說明文件更新為成功合併的最新樣式指南，因此我相信整個工作流程，而且會定期做出貢獻。
初次參與內容時，我遇到了一些錯誤。我終於習慣，每次都會執行測試和建立文件，然後才提交變更，這很重要。
我很樂意參與這項專案，也很期待。