Project SymPy
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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.
Kecuali disebutkan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-11-08 UTC.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Informasi yang saya butuhkan tidak ada","missingTheInformationINeed","thumb-down"],["Terlalu rumit/langkahnya terlalu banyak","tooComplicatedTooManySteps","thumb-down"],["Sudah usang","outOfDate","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Masalah kode / contoh","samplesCodeIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2024-11-08 UTC."],[[["This project focuses on improving the consistency of docstrings within the SymPy codebase."],["A documentation formatting and style guide will be created and implemented to standardize docstrings."],["The guide will address inconsistencies in formatting, language, and terminology for developers and contributors."],["The project is part of Google Season of Docs and will be completed over three months."]]],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]
