หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- SymPy
- ผู้เขียนด้านเทคนิค:
- Soumi7
- ชื่อโปรเจ็กต์:
- ความสอดคล้องในสตริงเอกสาร - เอกสารประกอบของ Sympy
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
บทคัดย่อ :
สถานะปัจจุบันของเอกสาร Sympy และงานก่อนหน้า :
งานสร้างคู่มือรูปแบบอย่างเป็นทางการสำหรับ SymPy เสร็จสมบูรณ์แล้ว
โปรเจ็กต์ GSoD ของ Lauren Glattly ได้สร้างคู่มือสไตล์สำหรับสตริงเอกสารของ SymPy ซึ่งดูได้ที่ SymPy Documentation Style Guide
สตริงเอกสารในโมดูลย่อยแบบพิเศษและไฟล์ Sols.py ได้รับการแก้ไขเพื่อให้เป็นไปตามหลักเกณฑ์ของคู่มือเวอร์ชันใหม่ล่าสุด
สตริงเอกสารอื่นๆ ทั้งหมดในฐานของโค้ดก็ยังคงได้รับการแก้ไขเพื่อให้สอดคล้องกับคู่มือสไตล์ใหม่นี้เช่นกัน
งานที่เสนอ :
สตริงเอกสารส่วนใหญ่ใน SymPy ยังคงไม่เป็นไปตามคู่มือสไตล์ล่าสุด เป้าหมายของโครงการนี้คือการอัปเดตสตริงเอกสารทั่วทั้ง SymPy ให้เป็นไปตามคู่มือนี้
ผมได้หารือเกี่ยวกับโครงการกับที่ปรึกษา นี่คือลิงก์การสนทนา
ลงความเห็นว่าการแก้ไข docstring ใน Codebase ของ sympy ให้เป็นไปตามคู่มือสไตล์ล่าสุดเป็นงานใหญ่และควรจำกัดโปรเจ็กต์นี้
โครงการของฉันจะต้องมีการใช้คู่มือใหม่เพื่ออัปเดตสตริงเอกสารที่มีอยู่ ขณะเดียวกันก็รวบรวมและจัดการกับความไม่สอดคล้องกันอื่นๆ เช่น การใช้ภาษาหรือคำศัพท์
ลำดับของส่วนย่อยที่มีอยู่สามารถเปลี่ยนแปลงหรือตัดสินใจในภายหลังหรือเป็นงานแยกต่างหากก็ได้
การแสดงความแตกต่างในผลลัพธ์เมื่อมีการส่งค่าที่ต่างกันไปยังพารามิเตอร์ โดยเพิ่มตัวอย่างและการเพิ่มส่วนพารามิเตอร์
คอยเพิ่มตัวอย่างยากๆ ลงในส่วน Getcha และกับดัก
การมีส่วนร่วม: - #17887 : แก้ไขปัญหา #17887: เพิ่มส่วน DOCstring ที่ขาดหายไปในโมดูลย่อย "พิเศษ" ฉันเพิ่มส่วน "พารามิเตอร์" และ "ตัวอย่าง" ที่ขาดหายไปในฟังก์ชันบางส่วนของโมดูลย่อย "พิเศษ" ที่แก้ไขโดย L ทำตามคู่มือสไตล์ล่าสุดและเป็นแบบอย่างสำหรับ DOCstring ในอนาคตอย่างเคร่งครัด
นี่คือลิงก์ไปยัง PR ที่ผสานรวมแล้วของฉัน : https://github.com/sympy/sympy/pull/19334
- #19591 : ปัญหา #19591 ติดตามดูสไตล์คู่มือของเอกสาร ฉันได้เพิ่ม PR เพื่อแก้ไข docstring หลัก.ssympify ให้เป็นไปตามคู่มือรูปแบบล่าสุด ฉันได้เพิ่มคำอธิบายที่มีโครงสร้างและตัวอย่างเกี่ยวกับการใช้พารามิเตอร์ต่างๆ แล้ว
นี่คือลิงก์ไปยัง PR: https://github.com/sympy/sympy/pull/19613
เป้าหมายของโครงการ
ไทม์ไลน์ ก่อนวันที่ 17 สิงหาคม
- ร่วมให้ข้อมูลแก่องค์กรต่อไป
- ทำความคุ้นเคยกับเอกสารผู้ใช้และ sympy เวอร์ชันปัจจุบัน
- เรียนรู้เทคนิคและทักษะซึ่งจะเป็นประโยชน์ในระหว่างดำเนินโครงการ
การสร้างความผูกพันกับชุมชน : (17 สิงหาคม - 13 กันยายน 2020)
- กำหนดช่องทางและเวลาการสื่อสาร (เนื่องจากเวลาต่างกัน)
- ปรับแต่งเป้าหมายของฉันและกำหนดความคาดหวังทั้ง 2 ฝ่าย
- อภิปรายเกี่ยวกับลำดับการอัปเดตโมดูล
- สรุปลำดับของโมดูลการแก้ไขให้เสร็จเพื่อให้เป็นไปตามคู่มือสไตล์ DOCstring ล่าสุด
ระยะเวลาการจัดทำเอกสาร(14 กันยายน 2020 - 30 พฤศจิกายน 2020)
ตั้งเป้าหมายที่จะบรรลุเป้าหมายทุกสัปดาห์ โดยแนะนำให้อัปเดต docstring ของโมดูลหรือโมดูลย่อย 1 รายการต่อสัปดาห์หรือนานกว่านั้น
สำหรับโมดูลเหล่านี้ทั้งหมด เป้าหมายหลักของฉันคือการเพิ่มส่วนที่ขาดไป และปรับโครงสร้างสตริงเอกสารใหม่ตามคู่มือแนะนำสไตล์ล่าสุด ซึ่งรวมถึงการแสดงผลลัพธ์ที่แตกต่างกันที่ได้มาเมื่อมีการส่งค่าที่ต่างกันไปยังพารามิเตอร์ ระบบจะเพิ่มผลลัพธ์ที่ซับซ้อนทั้งหมดไปยังส่วน Gotchas และ Pitfalls
สัปดาห์ที่ 1 ( 14-21 กันยายน) : หลัก
สัปดาห์ที่ 2 (22 กันยายน - 29 กันยายน) : ฟังก์ชัน : ชุดค่าผสมโมดูลย่อย
สัปดาห์ที่ 3 (30 กันยายน - 6 ตุลาคม) : ฟังก์ชัน
สัปดาห์ที่ 4 (7 ตุลาคม - 14 ตุลาคม) : ลดความซับซ้อน, คริปโต
สัปดาห์ที่ 5 (15 ตุลาคม - 21 ตุลาคม) : ไดโอแฟนไทน์
สัปดาห์ที่ 6 (22 ตุลาคม - 29 ตุลาคม):โมดูลย่อยของ Holonomic :การดำเนินการ
สัปดาห์ที่ 7 (30 ตุลาคม - 7 พฤศจิกายน) : โมดูล Integrals(integrals.integrals), การคำนวณปริพันธ์โดยใช้ Meijer G-Functions
สัปดาห์ที่ 8 (8 พฤศจิกายน - 15 พฤศจิกายน) : ฟิสิกส์ ฟังก์ชันตอนท้ายของโมดูลหมวดหมู่ โมดูลการสร้างโค้ด โมดูลย่อยพิเศษ
สัปดาห์ที่ 9 (16 - 23 พฤศจิกายน) : ฟิสิกส์ ฟังก์ชันตอนท้ายของโมดูลหมวดหมู่ โมดูลการสร้างโค้ด โมดูลย่อยพิเศษ
สัปดาห์ที่ 10 (24 พฤศจิกายน - 30 พฤศจิกายน) : ส่วน Gotcha และ Pitfalls
30 พฤศจิกายน - 5 ธันวาคม 2020 เวลา 18.00 น. UTC: การส่งโปรเจ็กต์ขั้นสุดท้ายและการเขียนรายงาน
3-10 ธันวาคม 2020 เวลา 18.00 น. (UTC): การส่งโครงการความสำเร็จของโครงการและประสบการณ์การทำงานร่วมกับที่ปรึกษา
คุณสามารถเปลี่ยนแปลงลำดับของโมดูลที่กล่าวถึงในที่นี้ได้หลังจากพูดคุยเพิ่มเติมกับที่ปรึกษาแล้ว
ตามที่ Mentor แนะนำ ฉันจะเน้นการอัปเดตโมดูลเหล่านั้นก่อนเป็นอันดับแรก จากนั้นค่อยไปอัปเดตโมดูลที่ซับซ้อน
เหตุใดฉันจึงเป็นบุคคลที่เหมาะสมสำหรับโครงการนี้
ผมเชื่อว่าเราควรติดต่อเป็นผู้ดำเนินโครงการนี้เพราะเคยมีประสบการณ์ด้านการเขียนเชิงเทคนิคกับวิทยาการคอมพิวเตอร์มาก่อน และเชี่ยวชาญเรื่อง git และ github มาก
ฉันได้ส่ง PR เพื่ออัปเดตเอกสารเกี่ยวกับคู่มือสไตล์ล่าสุดใน Sympy ซึ่งผสานรวมเรียบร้อยแล้ว ฉันมั่นใจในขั้นตอนการทำงานและให้การสนับสนุนอย่างสม่ำเสมอ
เมื่อเริ่มมีส่วนร่วม ฉันพบข้อผิดพลาดบางอย่าง ในที่สุดผมก็คุ้นเคยกับการทดสอบและสร้างเอกสารทุกครั้งก่อนที่จะทำการเปลี่ยนแปลง เนื่องจากเป็นเรื่องสำคัญมาก
ฉันยินดีอย่างยิ่งที่จะได้มีส่วนร่วมในโครงการนี้และตั้งตารอคอย