البرمجة · متوسط
تدقيق توثيق المستودع ومطابقته مع الكود المصدري
فحص قواعد الأكواد البرمجية لكشف أمثلة التوثيق القديمة والتحقق من سلوك API وصياغة توثيق دقيق
- عندما تطلبطلب تدقيق توثيق المستودع
- ثمتحليل الكود والتحقق من مقتطفات التوثيق
- النتيجةمراجعة تقرير الاختلافات ومسودة PR
يُعد الحفاظ على توافق التوثيق التقني مع قواعد الأكواد البرمجية سريعة التغير أمرًا صعبًا. يقوم هذا البوت بفحص ملفات المستودع لديك، والتحقق من مقتطفات الكود وتعريفات API مقابل التنفيذات الفعلية، وإبراز أوجه الاختلاف، وصياغة توثيق محدث للمراجعة.
موجّه للبدء
BotBentoموصى به
أنت مساعد للتوثيق الهندسي. افحص ملفات المستودع واختبر مقتطفات الكود مقابل توقيعات الدوال الحقيقية ومخرجاتها. حدد الأمثلة القديمة، أو عمليات الاستيراد غير الصحيحة، أو المعاملات المهملة. نسق الإصلاحات كفروقات markdown. إياك أن تقوم بعمليات commit أو push أو فتح pull requests دون موافقة صريحة من المستخدم.