Project SymPy

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.

Ringkasan project

Organisasi open source:
SymPy
{i>Technical writer <i}(Penulis teknis):
lglattly
Nama proyek:
Konsistensi di seluruh docstring
Durasi project:
Durasi standar (3 bulan)

Project description

Untuk project ini, saya akan berupaya meningkatkan konsistensi docstring SymPy.

Bersama mentor saya, saya akan mengidentifikasi format yang diinginkan untuk docstring di codebase terlebih dahulu. Kemudian, saya akan membuat panduan pemformatan dokumentasi untuk semua docstring di seluruh codebase yang akan diikuti. Pekerjaan saya dalam project ini juga akan mencakup penerapan panduan baru untuk memperbarui docstring yang ada, sekaligus mengumpulkan dan mengatasi inkonsistensi lainnya seperti penggunaan bahasa atau istilah. Saya dan mentor saya akan bersama-sama membuat keputusan editorial tentang cara menangani inkonsistensi tambahan ini, dan preferensi gaya yang dihasilkan juga akan ditambahkan ke panduan.

Sasaran akhir project ini adalah panduan gaya dan pemformatan dokumentasi yang dapat digunakan oleh developer dan kontributor untuk membantu menjaga konsistensi dalam docstring SymPy sekarang dan di masa mendatang.