Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- SymPy
- Penulis teknis:
- Soumi7
- Nama project:
- Konsistensi di seluruh docstring - Dokumentasi Sympy
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Abstrak :
Status Saat Ini Dokumentasi Sympy dan pekerjaan sebelumnya :
Pekerjaan membuat panduan gaya resmi untuk SymPy telah selesai.
Project GSoD Lauren Glattly membuat panduan gaya untuk dokumen SymPy, yang dapat ditemukan di SymPy Documentation Style Guide.
Docstring dalam file submodul Khusus dan file resolver.py diedit agar secara konsisten mengikuti panduan panduan gaya baru
Semua docstring lainnya di seluruh codebase juga masih harus diedit agar sesuai dengan panduan gaya baru.
Pekerjaan yang Diusulkan :
Sebagian besar docstring di SymPy masih belum mengikuti panduan gaya terbaru. Tujuan project ini adalah memperbarui docstring di seluruh SymPy agar mematuhi panduan ini.
Saya mendiskusikan project dengan mentor. Berikut adalah tautan ke diskusi.
Diputuskan bahwa mengedit docstring di seluruh codebase sympy untuk mematuhi panduan gaya terbaru adalah tugas besar dan project harus dibatasi.
Pekerjaan saya dalam project ini akan mencakup penerapan panduan baru untuk memperbarui docstring yang ada, sekaligus mengumpulkan dan mengatasi inkonsistensi lainnya seperti penggunaan bahasa atau istilah.
Urutan subbagian yang ada dapat diubah atau diputuskan nanti atau sebagai tugas terpisah.
Menunjukkan perbedaan hasil saat nilai yang berbeda diteruskan ke parameter dengan menambahkan lebih banyak contoh beserta penambahan bagian parameter.
Terus tambahkan contoh rumit ke bagian masalah dan perangkap.
Kontribusi: - #17887 : Menangani masalah #17887: Menambahkan bagian docstring yang hilang di Submodul khusus. Saya menambahkan bagian Parameter dan Contoh yang hilang di beberapa fungsi submodul Specials yang diedit oleh L. Glattly untuk mengikuti panduan gaya terbaru dan berfungsi sebagai model untuk docstring mendatang.
Berikut adalah tautan ke PR gabungan saya : https://github.com/sympy/sympy/pull/19334
- #19591 : Masalah #19591 melacak Panduan gaya dokumentasi. Saya menambahkan PR untuk mengedit docstring core.sympify agar mematuhi panduan gaya terbaru. Saya telah menambahkan penjelasan terstruktur dan contoh tentang penggunaan berbagai parameter.
Berikut link ke PR: https://github.com/sympy/sympy/pull/19613
Sasaran Project
Linimasa Sebelum 17 Agustus :
- Terus berkontribusi pada organisasi.
- Pahami dokumentasi pengguna dan versi sympy saat ini.
- Pelajari teknik dan keterampilan yang akan berguna saat menerapkan project.
Pengikatan komunitas : (17 Agustus - 13 September 2020)
- Siapkan saluran komunikasi dan waktu (karena perbedaan waktu).
- Pertajam sasaran saya dan tetapkan ekspektasi di kedua sisi.
- Membahas urutan pembaruan modul.
- Selesaikan urutan modul pengeditan agar mematuhi panduan gaya dokumen terbaru.
Periode Dokumentasi(14 September 2020 - 30 November 2020) :
Tetapkan tujuan yang ingin dicapai setiap minggu, sebaiknya selesaikan pembaruan docstring dari satu modul atau submodul per minggu atau lebih.
Untuk semua modul ini, tujuan utama saya adalah menambahkan bagian yang hilang dan menyusun ulang dokumen agar mengikuti panduan gaya terbaru. Hal ini akan mencakup demonstrasi berbagai hasil yang diperoleh saat nilai yang berbeda diteruskan ke parameter. Semua output yang rumit akan ditambahkan ke bagian Masalah dan Perangkap.
Minggu ke-1 ( 14 September - 21 September) : Inti
Minggu ke-2 (22 September - 29 September) : Fungsi : Submodul Kombinatorik
Minggu ke-3 (30 September - 6 Oktober) : Fungsi
Minggu 4 (7 Oktober - 14 Oktober) : Sederhanakan, Kripto
Minggu 5 (15 Oktober - 21 Oktober) : Diophantine
Minggu 6 (22 Oktober - 29 Oktober):Submodul Holonom :Operasi
Minggu 7 (30 Oktober - 7 November) : Modul Integral(integrals.integrals), Menghitung Integral menggunakan Fungsi G Meijer
Minggu 8 (8 November - 15 November) : Fisika, Fungsi di akhir Modul Kategori, Modul Pembuatan Kode, Submodul Khusus
Minggu 9 (16 November - 23 November) : Fisika, Fungsi di akhir Modul Kategori, Modul Pembuatan Kode, Submodul Khusus
Minggu ke-10 (24 November - 30 November) : Bagian Kesalahan dan Perangkap
30 November - 5 Desember 2020 pukul 18.00 UTC : Pengiriman Project Akhir dan Penulisan Laporan
3 - 10 Desember 2020 pukul 18.00 UTC : Pengiriman keberhasilan project dan pengalaman bekerja dengan mentor
Urutan modul yang disebutkan di sini dapat diubah setelah diskusi lebih lanjut dengan mentor.
Seperti yang disarankan oleh mentor, saya akan fokus untuk mengupdate modul tersebut terlebih dahulu yang lebih mudah diupdate, lalu beralih ke modul yang kompleks.
Mengapa saya orang yang tepat untuk project ini?
Saya yakin saya adalah orang yang tepat untuk project ini karena saya memiliki pengalaman sebelumnya dalam penulisan teknis dengan Ilmu Komputer dan saya sangat memahami git dan github.
Karena saya telah mengirimkan PR untuk memperbarui dokumentasi ke panduan gaya terbaru di sympy yang telah berhasil digabungkan, saya yakin dengan alur kerja dan membuat kontribusi secara rutin.
Awalnya, saat mulai berkontribusi, saya mengalami beberapa error. Akhirnya saya terbiasa menjalankan pengujian dan membangun dokumen setiap kali melakukan perubahan karena hal itu sangat penting.
Saya sangat nyaman untuk berkontribusi ke proyek ini dan menantikannya.