إضافة توثيق داخلي للدوال
وصف الاستخدام
كتابة docstrings وتعليقات تشرح «لماذا» لا «ماذا».
نص الأمر
أضف توثيقاً للدوال العامة في {{extra}} من {{project}} بأسلوب {{stack}}.
- وصف الغرض، المعاملات، القيمة المعادة، الاستثناءات، مثال قصير.
- تعليقات داخلية فقط حيث يكون السبب غير واضح.
- لا تغيّر أي سطر تنفيذي.المدخلات المطلوبة
الملفات، أسلوب التوثيق.
المخرجات المتوقعة
ملفات موثقة.
الأدوات المناسبة
مثال تطبيقي
stack = «Google style docstrings».
لم يُدَّعَ اختبار هذا الأمر على نموذج بعينه؛ النتائج تختلف حسب النموذج والسياق، فراجع المخرجات دائماً.
