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