โปรเจ็กต์ SymPy
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- SymPy
- นักเขียนเชิงเทคนิค:
- lglattly
- ชื่อโปรเจ็กต์:
- ความสอดคล้องกันของสตริงเอกสารประกอบ
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
สำหรับโปรเจ็กต์นี้ เรามุ่งมั่นที่จะเพิ่มความสอดคล้องให้กับ docstring ของ SymPy
ในการทำงานร่วมกับที่ปรึกษา ฉันจะระบุรูปแบบที่ต้องการสำหรับสตริงเอกสารในฐานของโค้ด จากนั้นผมจะสร้างคู่มือการจัดรูปแบบเอกสารสำหรับ docstring ทั้งหมดใน Codebase ที่จะปฏิบัติตาม งานของเราในโปรเจ็กต์นี้ยังเกี่ยวข้องกับการใช้คําแนะนําใหม่เพื่ออัปเดตสตริงเอกสารที่มีอยู่แล้ว รวมถึงรวบรวมและแก้ไขความไม่สอดคล้องอื่นๆ เช่น การใช้ภาษาหรือคําศัพท์ เราจะปรึกษากับที่ปรึกษาเพื่อหาวิธีจัดการกับความไม่สอดคล้องกันเพิ่มเติมเหล่านี้ และเราจะเพิ่มรูปแบบที่เลือกไว้ลงในคู่มือด้วย
เป้าหมายสุดท้ายของโปรเจ็กต์นี้คือรูปแบบและคู่มือสไตล์ของเอกสารประกอบที่นักพัฒนาซอฟต์แวร์และผู้มีส่วนร่วมสามารถใช้เพื่อช่วยรักษาความสอดคล้องของสตริงเอกสารของ SymPy ในปัจจุบันและอนาคต
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2024-11-08 UTC
[[["เข้าใจง่าย","easyToUnderstand","thumb-up"],["แก้ปัญหาของฉันได้","solvedMyProblem","thumb-up"],["อื่นๆ","otherUp","thumb-up"]],[["ไม่มีข้อมูลที่ฉันต้องการ","missingTheInformationINeed","thumb-down"],["ซับซ้อนเกินไป/มีหลายขั้นตอนมากเกินไป","tooComplicatedTooManySteps","thumb-down"],["ล้าสมัย","outOfDate","thumb-down"],["ปัญหาเกี่ยวกับการแปล","translationIssue","thumb-down"],["ตัวอย่าง/ปัญหาเกี่ยวกับโค้ด","samplesCodeIssue","thumb-down"],["อื่นๆ","otherDown","thumb-down"]],["อัปเดตล่าสุด 2024-11-08 UTC"],[[["This project focuses on improving the consistency of docstrings within the SymPy codebase."],["A documentation formatting and style guide will be created and implemented to standardize docstrings."],["The guide will address inconsistencies in formatting, language, and terminology for developers and contributors."],["The project is part of Google Season of Docs and will be completed over three months."]]],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]
