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:
- lglattly
- Projenin adı:
- Dökümanlar genelinde tutarlılık
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projede SymPy'nin doküman dizelerini daha tutarlı hale getirmeyi amaçlıyorum.
Mentorlarımla çalışarak önce kod tabanında bir docstring için istenen biçimlendirmeyi belirlerim. Ardından, kod tabanındaki tüm doküman dizeleri için izlenecek bir belge biçimlendirme kılavuzu oluşturuyorum. Projedeki çalışmalarım bir yandan dil kullanımı ve terimler gibi diğer tutarsızlıkları toplayıp giderirken bir yandan da mevcut doküman dizelerini güncellemeye yönelik yeni kılavuzu uygulamayı içeriyor. Mentorlarım ve ben, bu ek tutarsızlıkların nasıl ele alınacağına dair editoryal kararları birlikte veriyorduk. Bu şekilde oluşan biçimsel tercihler de rehbere eklenecek.
Projenin nihai hedefi, SymPy'nin doküman dizelerinde şimdi ve gelecekte tutarlılığı korumak için hem geliştiriciler hem de katkıda bulunanlar tarafından kullanılabilecek bir belge biçimlendirmesi ve stil kılavuzu olacaktır.