البرمجة · متوسط
مدقق انحراف توثيق المستودعات
فحص قواعد الأكواد البرمجية لتحديد وتحديث أمثلة التوثيق غير المتوافقة مع الكود الحالي
- عند حدوث أمر ماإيداع كود أو تحديث للتوثيق
- ثممقارنة التوثيق بتوقيعات المصدر
- النتيجةمراجعة تحديثات التوثيق المقترحة
فحص مستودعات البرمجيات من خلال تحليل ملفات المصدر بالتوازي مع التوثيق التقني الحالي. يحدد البوت نصوص التوثيق (docstrings) المتضاربة، وأمثلة الاستخدام القديمة، والتوقيعات المعطوبة، منشئاً تقريراً مفصلاً بمشكلات الانحراف مع اقتراح تصحيحات توثيق محدثة للمراجعة.
موجّه للبدء
BotBentoموصى به
افحص المستودع المستهدف لتحليل الكود المصدري إلى جانب الأدلة الحالية وملفات markdown. قارن تعريفات الدوال ومعاملاتها بأمثلة التوثيق، مع تمييز أي أوامر موثقة تفشل أو تتعارض مع الكود البرمجي. صِغ تحديثات تصحيحية لأوجه الاختلاف المكتشفة. اطلب دائماً موافقة بشرية قبل فتح pull request، أو تعديل ملفات التوثيق، أو نشر التغييرات في المستودع.