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:
- lglattly
- Proje adı:
- Belge açıklamalarında tutarlılık
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projede, SymPy'nin docstring'larına daha fazla tutarlılık getirmeyi amaçlıyorum.
Mentorlarımla birlikte çalışarak önce kod tabanında bir doküman dizesi için istenen biçimlendirmeyi belirlerim. Ardından, kod tabanındaki tüm docstring'lerin uyması gereken bir doküman biçimlendirme kılavuzu oluşturuyorum. Projedeki çalışmalarım arasında, 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 almak da yer alacak. Bu ilave tutarsızlıkların nasıl giderileceğine dair editoryal kararları birlikte danışmanlarla birlikte alıyoruz. Ortaya çıkan stil tercihleri de rehbere eklenecek.
Projenin nihai hedefi, SymPy'nin docstring'lerinde şimdi ve gelecekte tutarlılığı sağlamak için hem geliştiriciler hem de katkıda bulunanlar tarafından kullanılabilecek bir doküman biçimlendirme ve stil kılavuzu oluşturmaktır.