openedx / openedx/code-annotations
Remove ability to comment between annotations
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 5
- Fork
- 13
- Merge trung bình
- 18 giờ 26 phút
- Pull request đã merge (30 ngày)
- 4
Mô tả
It has been discussed during toggles annotation work that the ability to intermix comments between code annotations doesn't seem to add much value, and instead adds implementation complexity and bugs.
See example test file for this use case:
https://github.com/openedx/code-annotations/blob/master/tests/extensions/python_test_files/multiline_singlelinecomment.pyt
See toggle annotation PR comment about potential issue with linting due to this issue: https://github.com/openedx/edx-platform/pull/27222#discussion_r606037209.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với tests/extensions/python_test_files/multiline_singlelinecomment.pyt, tệp minh họa các chú thích được xen kẽ giữa các annotation, sau đó lần theo phần triển khai được fixture đó thực thi. Xóa hỗ trợ cho cách sắp xếp này, cập nhật các kỳ vọng liên quan và xác minh rằng việc phân tích cú pháp và linting annotation không còn chấp nhận chú thích giữa các annotation mã.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- tooling
- Loại issue
- Tái cấu trúc
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100