Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of Dokumen.
Ringkasan proyek
- Organisasi open source:
- SymPy
- Penulis teknis:
- dengan lambat
- Nama proyek:
- Konsistensi di seluruh dokumen
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Untuk proyek ini, saya ingin memberikan konsistensi yang lebih baik pada dokumen SymPy.
Bekerja dengan mentor saya, pertama-tama saya mengidentifikasi format yang diinginkan untuk docstring dalam codebase. Kemudian saya akan membuat panduan pemformatan dokumentasi untuk semua docstring di seluruh codebase yang akan diikuti. Pekerjaan saya di proyek ini juga akan melibatkan penerapan panduan baru untuk memperbarui docstring 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.