Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- SymPy
- Người viết nội dung kỹ thuật:
- Soumi7
- Tên dự án:
- Tính nhất quán trên các docstring – Tài liệu Sympy
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Tóm tắt :
Trạng thái hiện tại của tài liệu Sympy và công việc trước đó :
Công việc tạo hướng dẫn định kiểu chính thức cho SymPy đã hoàn tất.
Dự án GSoD của Lauren Glattly đã tạo một hướng dẫn về kiểu cho docstring SymPy. Bạn có thể tìm thấy hướng dẫn này tại Hướng dẫn về kiểu tài liệu SymPy.
Các docstring trong mô-đun con Special và tệp solvers.py đã được chỉnh sửa để nhất quán theo các nguyên tắc của hướng dẫn quy tắc lập trình mới
Tất cả các chuỗi ký tự khác trên cơ sở mã cũng phải được chỉnh sửa để tuân thủ hướng dẫn quy tắc mới.
Công việc đề xuất :
Hầu hết các docstring trong SymPy vẫn không tuân theo hướng dẫn về kiểu mới nhất. Mục tiêu của dự án này là cập nhật docstring trong toàn bộ SymPy để tuân thủ hướng dẫn này.
Tôi đã thảo luận về dự án này với các cố vấn. Sau đây là đường liên kết đến cuộc thảo luận.
Chúng tôi đã quyết định rằng việc chỉnh sửa docstring trong toàn bộ cơ sở mã của sympy để tuân thủ hướng dẫn quy tắc lập trình mới nhất là một nhiệm vụ lớn và dự án nên được giới hạn ở nhiệm vụ đó.
Công việc của tôi trong dự án này sẽ bao gồm việc triển khai hướng dẫn mới để cập nhật các docstring hiện có, đồng thời thu thập và giải quyết các điểm không nhất quán khác như việc sử dụng ngôn ngữ hoặc thuật ngữ.
Thứ tự của các phần phụ hiện có có thể được thay đổi hoặc quyết định sau hoặc dưới dạng một tác vụ riêng.
Minh hoạ sự khác biệt về kết quả khi các giá trị khác nhau được truyền vào tham số bằng cách thêm các ví dụ khác cùng với phần tham số.
Tiếp tục thêm các ví dụ khó vào phần lưu ý và cạm bẫy.
Đóng góp: – #17887 : Đã xử lý vấn đề #17887: Thêm các phần chuỗi tài liệu bị thiếu trong Mô-đun con đặc biệt. Tôi đã thêm phần Tham số và Ví dụ bị thiếu trong một số hàm của mô-đun con Specials do L chỉnh sửa. Glattly để tuân theo hướng dẫn về kiểu mới nhất và đóng vai trò là mô hình cho các docstring trong tương lai.
Đây là liên kết đến PR đã hợp nhất của tôi : https://github.com/sympy/sympy/pull/19334
- #19591 : Vấn đề #19591 theo dõi Hướng dẫn về văn phong viết tài liệu. Tôi đã thêm một yêu cầu phát hành để chỉnh sửa docstring core.sympify nhằm tuân thủ hướng dẫn về kiểu mới nhất. Tôi đã thêm nội dung giải thích có cấu trúc và ví dụ về cách sử dụng các tham số khác nhau.
Sau đây là đường liên kết đến PR: https://github.com/sympy/sympy/pull/19613
Mục tiêu dự án
Tiến trình trước ngày 17 tháng 8 :
- Tiếp tục đóng góp cho tổ chức.
- Làm quen hơn với tài liệu người dùng và phiên bản sympy hiện tại.
- Tìm hiểu các kỹ thuật và kỹ năng hữu ích trong quá trình triển khai dự án.
Tạo mối liên kết cộng đồng : (17 tháng 8 – 13 tháng 9 năm 2020)
- Thiết lập kênh và thời gian liên lạc (do chênh lệch thời gian).
- Điều chỉnh mục tiêu và đặt ra kỳ vọng cho cả hai bên.
- Thảo luận về thứ tự cập nhật các mô-đun.
- Hoàn tất thứ tự chỉnh sửa các mô-đun để đảm bảo các mô-đun này tuân thủ hướng dẫn kiểu chuỗi tài liệu mới nhất.
Thời gian cung cấp tài liệu(từ ngày 14 tháng 9 năm 2020 đến ngày 30 tháng 11 năm 2020) :
Đặt mục tiêu cần đạt được mỗi tuần, tốt nhất là hoàn thành việc cập nhật docstring của một mô-đun hoặc mô-đun con mỗi tuần hoặc nhiều hơn.
Đối với tất cả các mô-đun này, mục tiêu chính của tôi là thêm các phần bị thiếu và sắp xếp lại cấu trúc các chuỗi tài liệu để tuân theo hướng dẫn quy tắc mới nhất. Hoạt động này sẽ bao gồm việc minh hoạ các kết quả khác nhau thu được khi truyền các giá trị khác nhau đến các thông số. Tất cả kết quả khó hiểu sẽ được thêm vào phần Gotchas and Pitfalls (Cạm bẫy và cạm bẫy).
Tuần 1 ( 14/9 — 21/9) : Cốt lõi
Tuần 2 (22/9 – 29/9) : Hàm : Mô-đun con kết hợp
Tuần 3 (30 tháng 9 – 6 tháng 10) : Hàm
Tuần 4 (7/10 – 14/10) : Rút gọn, tiền mã hoá
Tuần 5 (15/10 – 21/10) : Diophantine
Tuần 6 (22/10 – 29/10): Mô-đun con Operations (Thao tác) của Holonomic
Tuần 7 (30 tháng 10 – 7 tháng 11) : Mô-đun tích phân(integrals.integrals), Tính tích phân bằng hàm G của Meijer
Tuần 8 (8/11 – 15/11) : Vật lý, Hàm ở cuối mô-đun Danh mục, Mô-đun tạo mã, Mô-đun con đặc biệt
Tuần 9 (16/11 – 23/11) : Vật lý, Hàm ở cuối mô-đun Danh mục, Mô-đun tạo mã, Mô-đun con đặc biệt
Tuần 10 (24/11 – 30/11) : Mục Lưu ý và cạm bẫy
18:00 giờ UTC ngày 30 tháng 11 – 5 tháng 12 năm 2020 : Gửi dự án cuối cùng và viết báo cáo
Từ 18:00 giờ UTC ngày 3 tháng 12 đến 18:00 giờ UTC ngày 10 tháng 12 năm 2020: Gửi thông tin về thành công của dự án và kinh nghiệm làm việc với người cố vấn
Thứ tự của các mô-đun được đề cập ở đây có thể thay đổi sau khi thảo luận thêm với người cố vấn.
Theo đề xuất của các cố vấn, trước tiên, tôi sẽ tập trung cập nhật những mô-đun dễ cập nhật hơn, sau đó chuyển sang các mô-đun phức tạp.
Tại sao tôi là người phù hợp cho dự án này?
Tôi tin rằng mình là người phù hợp cho dự án này vì tôi có kinh nghiệm viết kỹ thuật trong lĩnh vực Khoa học máy tính và tôi thành thạo git và github.
Vì tôi đã gửi các yêu cầu thay đổi để cập nhật tài liệu theo hướng dẫn về kiểu mới nhất trong sympy và các yêu cầu này đã được hợp nhất thành công, nên tôi tự tin với quy trình làm việc và thường xuyên đóng góp.
Ban đầu khi bắt đầu đóng góp, tôi gặp phải một số lỗi. Cuối cùng, tôi đã quen với việc chạy các chương trình kiểm thử và tạo tài liệu mỗi khi thực hiện thay đổi vì đó là điều rất quan trọng.
Tôi rất sẵn lòng đóng góp cho dự án này và rất mong được tham gia.