本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- SymPy
- 技術撰稿人：
- Soumi7
- 專案名稱：
- 文件字串的一致性 - Sympy 說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
摘要：
Sympy 說明文件和先前作品的現況：
我們已完成製作 SymPy 官方樣式指南的工作。
Lauren Glattly 的 GSoD 專案為 SymPy docstrings 制定風格指南，您可以前往 SymPy 說明文件樣式指南中找到相關內容。
對特殊子模組和 resolvers.py 檔案中的 docstrings 經過編輯，一致地遵循新樣式指南的規範
程式碼集的所有其他 docString 仍在修改，以符合新的樣式指南。
提案：
SymPy 中大多數 docstring 仍然不會遵循最新的樣式指南。這項專案的目標是更新整個 SymPy 中的 docstring，以符合本指南。
我和導師討論了這項專案。以下是該討論的連結。
結果發現，依照最新風格指南來編輯整個 sympy 程式碼集的 docString 是相當艱鉅的任務，而且專案應有其限制。
我的專案需要執行新指南來更新現有文件字串，同時收集和解決語言使用或字詞等其他不一致的問題。
現有子區段的順序可於日後變更或決定，也可視為獨立工作。
加入更多範例並加入參數部分，藉此說明將不同值傳遞至參數時的結果差異。
繼續在「正確」部分加入棘手範例。
貢獻： - #17887：已解決問題 #17887：在特殊子模組中新增缺少的 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 日前：
- 繼續為機構做出貢獻。
- 熟悉使用者說明文件及目前版本的 sympy。
- 瞭解在實作專案時有用的技巧和技能。
社群凝結：(2020 年 8 月 17 日 - 9 月 13 日)
- 建立溝通管道和時間 (因為時差)。
- 修正我的目標，並在雙方之間設定期望。
- 討論模組更新順序。
- 完成編輯模組的順序，確保模組符合最新的 docstring 樣式指南。
文件期間(2020 年 9 月 14 日 - 2020 年 11 月 30 日)：
設定每週目標，建議每週或更多個模組或子模組更新 docstring。
針對所有這些模組，我的主要目標是加入缺少的區段，並根據最新的風格指南，重新建構 docString。這包括展示不同值傳遞至參數時得到的不同結果。所有棘手的輸出結果都應新增至「Gotchas」和「陷阱」一節。
第 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 計算 Integrals
第 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 的最新風格指南，我對工作流程很有信心，並定期做出貢獻。
剛開始貢獻內容時，我遇到一些錯誤。在修訂之前，我終於不斷執行測試及建立文件，然後才提交變更，這一點非常重要。
我非常樂意為這項專案貢獻心力，也非常期待能做出貢獻。