โปรเจ็กต์ SymPy

หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส

SymPy

นักเขียนเชิงเทคนิค:

lglattly

ชื่อโปรเจ็กต์:

ความสอดคล้องกันของสตริงเอกสารประกอบ

ระยะเวลาของโปรเจ็กต์

ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

สำหรับโปรเจ็กต์นี้ เรามุ่งมั่นที่จะเพิ่มความสอดคล้องให้กับ docstring ของ SymPy

ในการทำงานร่วมกับที่ปรึกษา ฉันจะระบุรูปแบบที่ต้องการสำหรับสตริงเอกสารในฐานของโค้ด จากนั้นผมจะสร้างคู่มือการจัดรูปแบบเอกสารสำหรับ docstring ทั้งหมดใน Codebase ที่จะปฏิบัติตาม งานของเราในโปรเจ็กต์นี้ยังเกี่ยวข้องกับการใช้คําแนะนําใหม่เพื่ออัปเดตสตริงเอกสารที่มีอยู่แล้ว รวมถึงรวบรวมและแก้ไขความไม่สอดคล้องอื่นๆ เช่น การใช้ภาษาหรือคําศัพท์ เราจะปรึกษากับที่ปรึกษาเพื่อหาวิธีจัดการกับความไม่สอดคล้องกันเพิ่มเติมเหล่านี้ และเราจะเพิ่มรูปแบบที่เลือกไว้ลงในคู่มือด้วย

เป้าหมายสุดท้ายของโปรเจ็กต์นี้คือรูปแบบและคู่มือสไตล์ของเอกสารประกอบที่นักพัฒนาซอฟต์แวร์และผู้มีส่วนร่วมสามารถใช้เพื่อช่วยรักษาความสอดคล้องของสตริงเอกสารของ SymPy ในปัจจุบันและอนาคต