Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- SymPy
- Teknik yazar:
- Soumi7
- Proje adı:
- Doküman dizeleri arasında tutarlılık - Simge dokümanları
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Özet :
Mevcut Sympy Belgelerinin Durumu ve önceki çalışma :
SymPy için resmi bir stil kılavuzu oluşturma çalışması tamamlandı.
Lauren Glattly'nin GSoD projesi, SymPy belge dizeleri için bir stil kılavuzu oluşturdu. Bu kılavuzu SymPy Belgeleri Stil Kılavuzu’nda bulabilirsiniz.
Özel alt modül ve solvers.py dosyasındaki docstring'ler, yeni stil kılavuzunun kurallarına uygun olacak şekilde düzenlendi
Kod tabanındaki diğer tüm docstring'ler de yeni stil kılavuzuna uygun şekilde düzenlenecekti.
Önerilen Çalışma :
SymPy'deki docstring'lerin çoğu hâlâ en son stil kılavuzuna uymuyor. Bu projenin amacı, SymPy'deki belge dizelerini bu kılavuza uyacak şekilde güncellemektir.
Projeyi mentorlarla görüştüm. Tartışmanın bağlantısını burada bulabilirsiniz.
sympy'nin kod tabanında bulunan docstring'lerin en son stil kılavuzuna uygun şekilde düzenlenmesinin büyük bir iş olduğu ve projenin bununla sınırlı tutulması gerektiğine karar verildi.
Projedeki görevim, mevcut docstring'leri güncellemek için yeni kılavuzu uygulamak ve dil kullanımı veya terimler gibi diğer tutarsızlıkları toplamak ve ele almaktır.
Mevcut alt bölümlerin sırası değiştirilebilir veya daha sonra veya ayrı bir görev olarak belirlenebilir.
Parametreler bölümüne ek örnekler ekleyerek parametrelere farklı değerler aktarıldığında sonuçlardaki farklılıkları gösterme.
"Uyarılar ve tuzaklar" bölümüne zor örnekler eklemeye devam edin.
Katkılar: - #17887 : #17887 numaralı sorun üzerinde çalıştı: Özel alt modüle eksik açıklama metni bölümleri ekleyin. L tarafından düzenlenen Özellik alt modülünün bazı işlevlerine eksik Parametreler ve Örnekler bölümünü ekledim. En son stil kılavuzunu takip etmek ve gelecekteki belge dizeleri için model teşkil etmek.
Birleştirilmiş PR'min bağlantısı : https://github.com/sympy/sympy/pull/19334
- #19591: #19591 numaralı sorun, doküman stil kılavuzunu izler. core.sympify docstring'ini en son stil kılavuzuna uyacak şekilde düzenlemek için bir PR ekledim. Farklı parametrelerin kullanımıyla ilgili yapılandırılmış açıklamalar ve örnekler ekledim.
PR'nin bağlantısı: https://github.com/sympy/sympy/pull/19613
Proje Hedefleri
Zaman çizelgesi 17 Ağustos'tan önce :
- Kuruluşa katkıda bulunmaya devam etmek.
- Kullanıcı dokümanlarını ve sympy'nin mevcut sürümünü daha iyi öğrenin.
- Projeyi uygularken faydalı olacak teknikleri ve becerileri öğrenin.
Toplulukla bağ kurma : (17 Ağustos - 13 Eylül 2020)
- Bir iletişim kanalı ve zaman oluşturun (saat farkı nedeniyle).
- Hedeflerimi hassaslaştırın ve her iki taraf için de beklentileri belirleyin.
- Modüllerin güncelleneceği sırayı tartışma.
- Düzenleme modüllerinin sırasını, en son açıklama metni stil kılavuzuna uygun olacak şekilde kesinleştirin.
Belgeleme Dönemi(14 Eylül 2020 - 30 Kasım 2020) :
Her hafta ulaşacağınız hedefler belirleyin. Tercihen haftada bir veya daha fazla modülün/alt modülün docstring'lerini güncelleyin.
Tüm bu modüllerde temel hedefim, eksik bölümleri eklemek ve belge dizelerini en son stil kılavuzuna göre yeniden yapılandırmak. Bu, parametrelere farklı değerler aktarıldığında elde edilen farklı sonuçların gösterilmesini içerir. Tüm zor çıkışlar "Sık karşılaşılan sorunlar" bölümüne eklenir.
1. Hafta ( 14 Eylül - 21 Eylül) : Temel
2. Hafta (22 Eylül - 29 Eylül) : İşlevler : Alt Modüller Birleşik
3. Hafta (30 Eylül - 6 Ekim) : İşlevler
4. Hafta (7 Ekim - 14 Ekim) : Basitleştirme, Kripto
5. Hafta (15 Ekim - 21 Ekim) : Diophantine
6. Hafta (22 Ekim - 29 Ekim):Holonomik :Operasyonlar alt modülü
7. Hafta (30 Ekim - 7 Kasım) : Integrals Modülü(integrals.integrals), Meijer G Fonksiyonlarını kullanarak integralleri hesaplama
8. Hafta (8 Kasım - 15 Kasım) : Fizik, Kategoriler Modülünün sonundaki İşlevler, Kod Oluşturma Modülü, Alt Modül Özel
9. Hafta (16 Kasım - 23 Kasım) : Fizik, Kategoriler Modülü'nün sonundaki İşlevler, Kod Oluşturma Modülü, Alt Modül Özel
10. Hafta (24 Kasım - 30 Kasım) : Hatalar ve Tuzaklarla İlgili Bölüm
30 Kasım - 5 Aralık 2020, 18:00 (UTC): Nihai projenin gönderilmesi ve rapor yazımı
3 - 10 Aralık 2020, 18:00 (UTC): Projenin başarısı ve mentorlarla çalışma deneyiminin gönderilmesi
Burada bahsedilen modüllerin sırası, mentorlarla daha fazla görüştükten sonra değiştirilebilir.
Mentörlerin önerdiği gibi, önce güncellenmesi daha kolay olan modülleri güncellemeye odaklanacağım, ardından karmaşık olanlara geçeceğim.
Bu proje için neden doğru kişi benim?
Bilgisayar Bilimi ile teknik yazı konusunda geçmiş deneyimlerim ve git ile github konusunda bilgi sahibi olmam nedeniyle bu proje için doğru kişi olduğumu düşünüyorum.
PR'leri belgeleri Sympy'de başarıyla birleştirilen en son stil kılavuzuna güncellemek üzere gönderdiğim için iş akışından eminim ve düzenli olarak katkıda bulunuyorum.
Katkıda bulunmaya başladığımda bazı hatalarla karşılaştım. Çok önemli olduğu için nihayet değişiklikleri uygulamadan önce her seferinde testleri çalıştırmaya ve belgeleri derlemeye alıştım.
Bu projeye katkıda bulunacak kadar rahat hissediyorum ve katkım için sabırsızlanıyorum.