本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- SymPy
- 技術撰稿人：
- lglattly
- 專案名稱：
- docstring 的一致性
- 專案長度：
- 標準長度 (3 個月)
Project description
在這個專案中，我會致力讓 SymPy 的 docstring 更一致。
與導生合作時，我會先確認程式碼集內的 docString 需要哪些格式。接著，我會為整個程式碼庫中的所有 docstring 建立說明文件格式指南，供大家遵循。我在這項專案中的工作也包括導入新指南，以更新現有的 docstring，同時收集並解決其他不一致的問題，例如用語或術語。我的導師和我會一起決定如何處理這些不一致的地方，而產生的風格偏好設定也會加入指導員。
這個專案的最終目標是提供說明文件格式和樣式指南，供開發人員和貢獻者使用，以便在現在和未來保持 SymPy 的 docstring 一致性。