Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- SymPy
- Penulis teknis:
- Sangat sulit
- Nama proyek:
- Konsistensi di seluruh docstring
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Untuk project ini, saya ingin memberikan konsistensi yang lebih baik pada docstring SymPy.
Bekerja dengan mentor saya, pertama-tama saya akan mengidentifikasi format yang diinginkan untuk docstring dalam codebase. Saya kemudian akan membuat panduan pemformatan dokumentasi untuk semua docstring di seluruh codebase untuk diikuti. Pekerjaan saya pada proyek ini juga akan melibatkan implementasi panduan baru untuk memperbarui dokumen yang ada, sambil mengumpulkan dan mengatasi inkonsistensi lainnya seperti penggunaan bahasa atau istilah. Saya dan mentor bersama-sama akan membuat keputusan editorial tentang cara menangani inkonsistensi tambahan ini, dan preferensi gaya yang dihasilkan juga akan ditambahkan ke panduan.
Tujuan akhir proyek ini adalah pemformatan dokumentasi dan panduan gaya yang dapat digunakan oleh developer dan kontributor untuk membantu menjaga konsistensi dalam docstring SymPy saat ini dan di masa mendatang.