本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- SymPy
- 技術文件撰寫者：
- 準備好
- 專案名稱：
- 文件字串的一致性
- 專案長度：
- 標準長度 (3 個月)
Project description
本專案的目標是提高 SymPy 文件字串的一致性。
我和導師合作，先在程式碼集中確定 docstring 所需的格式。接下來我會為程式碼集中的所有 docstring 建立說明文件格式指南，以便遵循的規定。我的專案成果還包括根據新指南更新現有文件字串，以及收集和處理其他不一致的問題，例如語言使用或字詞。我的導師和我都會共同製定編輯決策，決定如何處理這些不一致的問題，最後的風格偏好設定也將納進指南中。
這項專案的最終目標是設計文件格式和樣式指南，開發人員與貢獻者都能使用這份指南，協助確保 SymPy 文件字串的一致性與日後發展。