Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- SymPy
- Teknik yazar:
- Soumi7
- Projenin adı:
- Döküm dizeleri arasında tutarlılık - Sympy dokümanları
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Özet :
Sympy Belgelerinin Mevcut Durumu ve önceki çalışma :
SymPy için resmi 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ılavuza SymPy Belgeleme Stil Kılavuzu'ndan ulaşılabilir.
Özel alt modül ve solvers.py dosyasındaki doküman dizeleri, yeni stil kılavuzunun yönergelerine uygun olacak şekilde düzenlendi
Kod tabanındaki diğer tüm doküman dizeleri hâlâ yeni stil kılavuzuyla uyumlu olacak şekilde düzenlendi.
Önerilen Çalışma :
SymPy'deki çoğu docstring hâlâ en son stil kılavuzuna uymamaktadır. Bu projenin amacı, SymPy'deki doküman dizelerini bu kılavuza uygun şekilde güncellemektir.
Mentorlarla proje hakkında konuştuk. Tartışmanın bağlantısını burada bulabilirsiniz.
Sympy'nin kod tabanında en son stil kılavuzuna göre doküman dizelerini düzenlemenin büyük bir görev olduğuna ve projenin bununla sınırlı olması gerektiğine karar verildi.
Projemdeki çalışmalarım arasında, mevcut doküman dizelerini güncellemek için yeni kılavuzun uygulanması sırasında, bir yandan da dil kullanımı ve terimler gibi diğer tutarsızlıkların toplanması ve ele alınması yer alıyor.
Mevcut alt bölümlerin sırası değiştirilebilir veya daha sonra ya da ayrı bir görev olarak değiştirilebilir.
Parametreler bölümünün yanı sıra daha fazla örnek ekleyerek parametrelere farklı değerler aktarıldığında sonuçlardaki farklılıkları gösterme.
Kazalar ve tehlikeler bölümüne ustalık isteyen örnekler eklemeye devam edin.
Katkılar: - #17887 : 17887 numaralı sorun üzerinde çalışıldı: Özel alt modüle eksik docstring bölümlerini ekleyin. L tarafından düzenlenen Spesiyaller alt modülünün bazı işlevlerine eksik Parametreler ve Örnekler bölümünü ekledim. En son stil kılavuzuna göre hareket etmek ve gelecekte yayınlayacağınız doküman dizeleri için bir model olmak
Birleştirilen halkla ilişkiler adresimin bağlantısı : https://github.com/sympy/sympy/pull/19334
- #19591 : Sorun #19591, Dokümantasyon stil kılavuzunu takip etmektedir. Core.sympify docstring'i en son stil kılavuzuna uyacak şekilde düzenlemek için bir halkla ilişkiler kuralı ekledim. Farklı parametrelerin kullanımıyla ilgili yapılandırılmış açıklamalar ve örnekler ekledim.
Halkla ilişkiler 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 etmeli.
- Kullanıcı belgeleri ve sympy'nin mevcut sürümü hakkında daha fazla bilgi edinin.
- Projeyi uygularken faydalı olacak teknikleri ve becerileri öğrenme.
Topluluk bağları : (17 Ağustos - 13 Eylül 2020)
- Saat farkı nedeniyle bir iletişim kanalı ve zaman oluşturun.
- Hedeflerimi iyileştirip iki tarafta da beklentilerimi belirle.
- Modüllerin güncelleneceği sırayı tartışma.
- Düzenleme modüllerini sıralayarak en son docstring stil kılavuzuna uygun hale getirin.
Dokümantasyon Dönemi(14 Eylül 2020 - 30 Kasım 2020) :
Her hafta ulaşmak istediğiniz hedefler belirleyin, tercihen haftada en az bir modülün veya alt modülün güncel dosya dizelerini tamamlayın.
Tüm bu modüllerde birincil hedefim eksik bölümleri eklemek ve doküman dizelerini en son stil kılavuzuna göre yeniden yapılandırmaktır. Bu, parametrelere farklı değerler geçirildiğinde elde edilen farklı sonuçların gösterilmesini içerir. Tüm yanıltıcı sonuçlar, Gotcha'lar ve Tuzaklar bölümüne eklenmelidir.
1. Hafta ( 14 Eylül - 21 Eylül) : Temel
2. Hafta (22 Eylül - 29 Eylül) : İşlevler : Alt Modüller Kombinatörü
3. Hafta (30 Eylül - 6 Ekim) : İşlevler
4. Hafta (7 Ekim - 14 Ekim) : Sadeleştirme, Kripto
5. Hafta (15 Ekim - 21 Ekim) : Diophantine
6. Hafta (22 Ekim - 29 Ekim):Holonomi :İşlemler alt modülü
7. Hafta (30 Ekim - 7 Kasım) : İntegrals Modülü(integrals.integrals), Meijer G İşlevlerini Kullanarak İntegralleri Hesaplama
8. Hafta (8 Kasım - 15 Kasım) : Fizik, Kategoriler Modülünün sonundaki işlevler, Kod Oluşturma Modülü, Özel Alt Modül
9. Hafta (16 Kasım - 23 Kasım) : Fizik, Kategoriler Modülünün sonundaki işlevler, Kod Oluşturma Modülü, Özel Alt Modül
10. Hafta (24 Kasım - 30 Kasım) : Gotcha'lar ve Tuzaklar bölümü
30 Kasım - 5 Aralık 2020, 18:00 UTC : Nihai Proje Gönderimi ve Rapor Yazma
3-10 Aralık 2020, 18:00 UTC : Projenin başarısı ve mentorlarla çalışma deneyimi
Burada bahsedilen modüllerin sırası, mentorlarla daha ayrıntılı bir şekilde tartışıldıktan sonra değiştirilebilir.
Mentorların önerdiği şekilde önce kolayca güncellenebilen bu modülleri güncellemeye odaklanıp sonra karmaşık modüllere geçeceğim.
Neden bu proje için doğru kişiyim?
Bilgisayar Bilimleri ile geçmişte teknik yazı yazma deneyimim olduğundan, git ve github'a hakim olduğum için bu proje için doğru kişi olduğuma inanıyorum.
Belgeleri Sympy'deki en son stil kılavuzuna göre güncellemek için halkla ilişkiler ekibini gönderdiğim ve bu kılavuzun başarıyla birleştirildiği iş akışı konusunda kendime güveniyorum ve düzenli olarak katkıda bulunuyorum.
İlk başta katkıda bulunmaya başladığımda bazı hatalarla karşılaştım. Sonunda değişiklikleri yapmaya başlamadan önce her seferinde testlere ve dokümanlar oluşturmaya alıştım. Bu çok önemli.
Bu projeye katkıda bulunma konusunda çok rahatım ve sabırsızlanıyorum.