SymPy projesi
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
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.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[[["Anlaması kolay","easyToUnderstand","thumb-up"],["Sorunumu çözdü","solvedMyProblem","thumb-up"],["Diğer","otherUp","thumb-up"]],[["İhtiyacım olan bilgiler yok","missingTheInformationINeed","thumb-down"],["Çok karmaşık / çok fazla adım var","tooComplicatedTooManySteps","thumb-down"],["Güncel değil","outOfDate","thumb-down"],["Çeviri sorunu","translationIssue","thumb-down"],["Örnek veya kod sorunu","samplesCodeIssue","thumb-down"],["Diğer","otherDown","thumb-down"]],["Son güncelleme tarihi: 2025-07-25 UTC."],[],["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"]]
