本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- SymPy
- 技術撰稿人：
- 加工
- 專案名稱：
- 文字字串的一致性
- 專案長度：
- 標準長度 (3 個月)
Project description
在這個專案中，我的目標是提升 SymPy 文件字串的一致性。
我與導師合作，首先在程式碼集中找出想要的 docstring 格式。接著，我會為程式碼集中的所有 docstrings 建立說明文件格式指南，以便遵循。我的專案也包括實施新指南來更新現有 doc 字串，同時收集和解決語言使用或術語等其他不一致的問題導師和我共同決定如何處理這些額外不一致的問題，完成之後的風格偏好設定也會列入指南中。
這項專案的最終目標是記錄文件格式和風格指南，供開發人員和貢獻者使用，協助目前和未來在 SymPy 文件字串中維持一致性。