หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- SymPy
- นักเขียนเชิงเทคนิค
- Soumi7
- ชื่อโปรเจ็กต์:
- ความสอดคล้องของสตริงเอกสารใน docstrings - เอกสารประกอบ Sympy
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ข้อมูลสรุป :
สถานะปัจจุบันของเอกสารประกอบ Sympy และงานก่อนหน้า :
การสร้างคู่มือสไตล์อย่างเป็นทางการสำหรับ SymPy เสร็จสมบูรณ์แล้ว
โปรเจ็กต์ GSoD ของ Lauren Glattly ได้จัดทำคู่มือสไตล์สำหรับ docstring ของ SymPy ซึ่งดูได้ที่คู่มือสไตล์ของเอกสารประกอบ SymPy
แก้ไข docstrings ในโมดูลย่อยพิเศษและไฟล์ solvers.py เพื่อให้เป็นไปตามหลักเกณฑ์ของคู่มือสไตล์แบบใหม่อย่างสอดคล้องกัน
สตริงเอกสารอื่นๆ ทั้งหมดในโค้ดเบสยังต้องได้รับการแก้ไขให้เป็นไปตามคู่มือสไตล์แบบใหม่ด้วย
งานเสนอ :
สตริงเอกสารส่วนใหญ่ใน SymPy ยังคงไม่เป็นไปตามคู่มือสไตล์ฉบับล่าสุด เป้าหมายของโปรเจ็กต์นี้คืออัปเดต docstring ทั่วทั้ง SymPy เพื่อให้เป็นไปตามคู่มือนี้
ฉันได้พูดคุยเกี่ยวกับโปรเจ็กต์กับที่ปรึกษาแล้ว ลิงก์ไปยังการสนทนามีดังนี้
เราตัดสินใจว่าการแก้ไข docstring ทั่วทั้งโค้ดเบสของ sympy เพื่อให้เป็นไปตามคู่มือสไตล์ล่าสุดเป็นงานที่ใหญ่มากและควรจำกัดให้อยู่ในโปรเจ็กต์นี้
งานของฉันในโปรเจ็กต์นี้เกี่ยวข้องกับการใช้คู่มือใหม่เพื่ออัปเดตสตริงเอกสารที่มีอยู่แล้ว พร้อมกับรวบรวมและแก้ไขความไม่สอดคล้องอื่นๆ เช่น การใช้ภาษาหรือคำศัพท์
คุณเปลี่ยนหรือตัดสินใจลำดับของส่วนย่อยที่มีอยู่ในภายหลังหรือเป็นงานแยกต่างหากก็ได้
แสดงความแตกต่างของผลลัพธ์เมื่อส่งค่าต่างๆ ไปยังพารามิเตอร์ด้วยการเพิ่มตัวอย่างเพิ่มเติมพร้อมกับการเพิ่มส่วนพารามิเตอร์
เพิ่มตัวอย่างที่ยุ่งยากลงในส่วนข้อควรระวังและข้อผิดพลาด
การร่วมให้ข้อมูล: - #17887 : ดำเนินการกับฉบับที่ 17887: เพิ่มส่วน docstring ที่ขาดหายไปในโมดูลย่อยพิเศษ เราได้เพิ่มส่วนพารามิเตอร์และตัวอย่างที่ขาดหายไปในฟังก์ชันบางอย่างของโมดูลย่อย Specials ซึ่ง L แก้ไข ทำตามคู่มือฉบับล่าสุดและใช้เป็นต้นแบบสำหรับเอกสารประเภทเอกสารในอนาคต
ลิงก์ไปยัง PR ที่ผสานแล้วของฉันคือ https://github.com/sympy/sympy/pull/19334
- #19591 : ปัญหา #19591 ติดตามคู่มือคำแนะนำเกี่ยวกับเอกสารประกอบ เราได้เพิ่ม PR เพื่อแก้ไข docstring ของ core.sympify ให้เป็นไปตามคู่มือสไตล์ฉบับล่าสุด เราได้เพิ่มคำอธิบายและตัวอย่างที่ชัดเจนเกี่ยวกับการใช้พารามิเตอร์ต่างๆ
ลิงก์ไปยัง PR มีดังนี้ https://github.com/sympy/sympy/pull/19613
เป้าหมายโปรเจ็กต์
ไทม์ไลน์ ก่อนวันที่ 17 สิงหาคม :
- มีส่วนร่วมกับองค์กรต่อไป
- ทําความคุ้นเคยกับเอกสารประกอบสําหรับผู้ใช้และ sympy เวอร์ชันปัจจุบันมากขึ้น
- ดูเทคนิคและทักษะที่เป็นประโยชน์ขณะใช้งานโปรเจ็กต์
การสร้างชุมชน : (17 สิงหาคม - 13 กันยายน 2020)
- กำหนดช่องทางและเวลาการสื่อสาร (เนื่องจากความแตกต่างของเวลา)
- ปรับแต่งเป้าหมายและกำหนดความคาดหวังของทั้ง 2 ฝ่าย
- พูดคุยเกี่ยวกับลำดับการอัปเดตโมดูล
- สรุปลำดับของโมดูลการแก้ไขเพื่อให้เป็นไปตามคู่มือสไตล์สตริงเอกสารประกอบฉบับล่าสุด
ระยะเวลาการส่งเอกสาร(14 กันยายน 2020 - 30 พฤศจิกายน 2020)
ตั้งเป้าหมายให้บรรลุทุกสัปดาห์ โดยควรอัปเดตสตริงเอกสารของโมดูลหรือโมดูลย่อยอย่างน้อย 1 รายการต่อสัปดาห์
สำหรับโมดูลเหล่านี้ทั้งหมด เป้าหมายหลักของฉันคือเพิ่มส่วนที่ขาดหายไปและจัดโครงสร้างเอกสารใหม่ตามคู่มือสไตล์ฉบับล่าสุด ซึ่งจะรวมถึงการแสดงผลลัพธ์ที่แตกต่างกันเมื่อส่งค่าต่างๆ ไปยังพารามิเตอร์ ระบบจะเพิ่มเอาต์พุตที่ยุ่งยากทั้งหมดลงในส่วน "ข้อควรระวังและข้อผิดพลาด"
สัปดาห์ที่ 1 ( 14 - 21 กันยายน) : เนื้อหาหลัก
สัปดาห์ที่ 2 (22 - 29 กันยายน) : ฟังก์ชัน : คอมบิเนโตเรียลย่อย
สัปดาห์ที่ 3 (30 กันยายน - 6 ตุลาคม) : ฟังก์ชัน
สัปดาห์ที่ 4 (7-14 ตุลาคม) : Simplify, Crypto
สัปดาห์ที่ 5 (15-21 ตุลาคม) : ไดโอแฟนทีน
สัปดาห์ที่ 6 (22 ตุลาคม - 29 ตุลาคม):โฮโลโนมิก :โมดูลย่อยของการปฏิบัติงาน
สัปดาห์ที่ 7 (30 ตุลาคม - 7 พฤศจิกายน) : โมดูลปริพันธ์(integrals.integrals) การคํานวณปริพันธ์โดยใช้ฟังก์ชัน G ของ Meijer
สัปดาห์ที่ 8 (8-15 พฤศจิกายน) : ฟิสิกส์ ฟังก์ชันที่ส่วนท้ายของโมดูลหมวดหมู่ โมดูลการสร้างโค้ด โมดูลย่อยพิเศษ
สัปดาห์ที่ 9 (16-23 พฤศจิกายน) : ฟิสิกส์ ฟังก์ชันที่ส่วนท้ายของโมดูลหมวดหมู่ โมดูลการสร้างโค้ด โมดูลย่อยพิเศษ
สัปดาห์ที่ 10 (24-30 พฤศจิกายน) : ส่วนข้อควรระวังและข้อผิดพลาด
30 พฤศจิกายน - 5 ธันวาคม 2020 เวลา 18:00 น. UTC : การส่งโครงการครั้งสุดท้ายและการเขียนรายงาน
วันที่ 3-10 ธันวาคม 2020 เวลา 18:00 น. UTC : การส่งรายงานความสำเร็จสำหรับโครงการและประสบการณ์ในการทำงานร่วมกับที่ปรึกษา
ลำดับของข้อบังคับที่กล่าวถึงที่นี่สามารถเปลี่ยนแปลงได้หลังจากการพูดคุยเพิ่มเติมกับที่ปรึกษา
เราจะมุ่งเน้นที่การอัปเดตโมดูลที่อัปเดตได้ง่ายก่อน ตามคำแนะนำของพี่เลี้ยง แล้วจึงค่อยไปอัปเดตโมดูลที่ซับซ้อน
เหตุใดฉันจึงเหมาะกับโปรเจ็กต์นี้
เราเชื่อว่าตัวเองเหมาะสมกับโปรเจ็กต์นี้เนื่องจากมีประสบการณ์ด้านงานเขียนเชิงเทคนิคเกี่ยวกับวิทยาการคอมพิวเตอร์และเชี่ยวชาญเรื่อง git และ GitHub
เนื่องจากฉันได้ส่ง PR เพื่ออัปเดตเอกสารประกอบตามคู่มือสไตล์ล่าสุดใน sympy ซึ่งผสานรวมเรียบร้อยแล้ว ฉันจึงมั่นใจในเวิร์กโฟลว์และจะมีส่วนร่วมเป็นประจำ
ตอนแรกที่เริ่มมีส่วนร่วม ฉันพบข้อผิดพลาดบางอย่าง ในที่สุดฉันก็ชินกับการเรียกใช้การทดสอบและสร้างเอกสารทุกครั้งก่อนที่จะทําการเปลี่ยนแปลง เนื่องจากสิ่งเหล่านี้สำคัญมาก
เรายินดีอย่างยิ่งที่จะมีส่วนร่วมในโปรเจ็กต์นี้และหวังว่าจะได้ร่วมงานกัน