Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- SymPy
- Penulis teknis:
- Soumi7
- Nama proyek:
- Konsistensi di seluruh docstring - Dokumentasi Sympy
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Abstrak :
Status Dokumentasi Sympy Saat Ini dan pekerjaan sebelumnya :
Pekerjaan membuat panduan gaya resmi untuk SymPy sudah selesai.
Proyek GSoD Lauren Glattly membuat sebuah panduan gaya untuk docstring SymPy, yang dapat ditemukan di SymPy Documentation Style Guide.
Docstring dalam submodul Khusus dan file solvers.py diedit untuk mengikuti pedoman panduan gaya baru secara konsisten
Semua docstring lain di seluruh codebase masih harus diedit untuk mematuhi panduan gaya yang baru.
Usulan Pekerjaan :
Sebagian besar docstring di SymPy masih tidak mengikuti panduan gaya terbaru. Tujuan proyek ini adalah untuk memperbarui docstring di seluruh SymPy agar mematuhi panduan ini.
Saya mendiskusikan proyek tersebut dengan para mentor. Berikut link ke diskusinya.
Diputuskan bahwa mengedit docstring di seluruh codebase sympy agar mematuhi panduan gaya terbaru merupakan tugas besar dan project harus dibatasi pada hal itu.
Pekerjaan saya pada proyek ini akan melibatkan implementasi panduan baru untuk memperbarui docstring yang ada, sambil mengumpulkan dan mengatasi inkonsistensi lain seperti penggunaan bahasa atau istilah.
Urutan subbagian yang ada dapat diubah atau diputuskan nanti atau sebagai tugas terpisah.
Mendemonstrasikan perbedaan hasil saat nilai yang berbeda diteruskan ke parameter dengan menambahkan lebih banyak contoh beserta bagian penambahan parameter.
Terus tambahkan contoh rumit ke bagian getcha dan perangkap.
Kontribusi: - #17887 : Telah menangani masalah #17887: Menambahkan bagian docstring yang hilang di submodul Khusus. Saya menambahkan bagian Parameter dan Contoh yang hilang di beberapa fungsi submodul Spesial yang diedit oleh L. Dengan senang hati 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 : Isu #19591 melacak panduan gaya Dokumentasi. Saya menambahkan bagian Humas untuk mengedit docstring core.sympify agar mematuhi panduan gaya terbaru. Saya telah menambahkan penjelasan dan contoh terstruktur tentang penggunaan parameter yang berbeda.
Berikut adalah tautan ke PR: https://github.com/sympy/sympy/pull/19613
Tujuan Proyek
Linimasa Sebelum 17 Agustus :
- Terus memberikan kontribusi kepada organisasi.
- Lebih memahami dokumentasi pengguna dan versi sympy saat ini.
- Mempelajari teknik dan keterampilan yang akan berguna saat menerapkan proyek.
Community bonding : (17 Agustus - 13 September 2020)
- Siapkan saluran dan waktu komunikasi (karena perbedaan waktu).
- Sempurnakan tujuan saya dan tetapkan ekspektasi dari kedua sisi.
- Mendiskusikan urutan pembaruan modul.
- Selesaikan urutan modul pengeditan agar mematuhi panduan gaya docstring terbaru.
Periode Dokumentasi(14 September 2020 - 30 November 2020) :
Tetapkan tujuan yang ingin dicapai setiap minggu, sebaiknya selesaikan pembaruan docstring satu modul atau submodul per minggu atau lebih.
Untuk semua modul ini, tujuan utama saya adalah menambahkan bagian yang hilang dan menyusun ulang docstring untuk mengikuti panduan gaya terbaru. Hal ini termasuk menunjukkan hasil berbeda yang diperoleh saat nilai yang berbeda diteruskan ke parameter. Semua {i>output<i} yang rumit harus ditambahkan ke bagian Gotcha dan Perangkap.
Minggu 1 ( 14 September - 21 September) : Core
Minggu ke-2 (22 September - 29 September) : Fungsi : Submodules Kombinasi
Minggu ke-3 (30 September - 6 Oktober) : Fungsi
Minggu ke-4 (7 Oktober - 14 Oktober) : Sederhanakan, Kripto
Minggu 5 (15 Oktober - 21 Oktober) : Diophantine
Minggu ke-6 (22 Oktober - 29 Oktober):Holonomic :Submodul
Minggu ke-7 (30 Oktober - 7 November) : Modul Integrals.integrals(integrals.integrals), Komputasi Integral menggunakan Meijer G-Functions
Minggu ke-8 (8 November - 15 November) : Fisika, Fungsi di akhir Modul Kategori, Modul Pembuatan Kode, Submodul Khusus
Minggu ke-9 (16 November – 23 November) : Fisika, Fungsi di akhir Modul Kategori, Modul Pembuatan Kode, Submodul Khusus
Minggu ke-10 (24 November - 30 November) : bagian Gotcha dan Perangkap
30 November - 5 Desember 2020 pukul 18:00 UTC : Penyerahan Tugas Akhir dan Penulisan Laporan
3 - 10 Desember 2020 pukul 18:00 UTC : Penyampaian keberhasilan proyek dan pengalaman bekerja dengan mentor
Urutan modul yang disebutkan di sini dapat diubah setelah diskusi lebih lanjut dengan para mentor.
Seperti yang disarankan oleh mentor, saya akan fokus memperbarui modul tersebut terlebih dahulu agar lebih mudah diperbarui, lalu beralih ke modul yang kompleks.
Mengapa saya adalah orang yang tepat untuk proyek ini?
Saya percaya diri saya adalah orang yang tepat untuk proyek ini karena saya memiliki pengalaman sebelumnya dalam menulis teknis dengan Ilmu Komputer dan saya sangat berpengalaman dengan 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 kerjanya dan memberikan kontribusi rutin.
Awalnya ketika saya mulai berkontribusi, saya menemui beberapa kesalahan. Saya akhirnya terbiasa menjalankan pengujian dan membangun dokumen setiap saat sebelum melakukan perubahan karena itu adalah hal yang sangat penting.
Saya sangat nyaman berkontribusi dalam proyek ini dan sangat menantikannya.