atom-community / atom-community/ide-python

Improve feature provider option descriptions

Đang mở
#98 4 bình luận 1 reaction 0 người được giao Xem trên GitHub
documentation good first issue
Ngôn ngữ chính
JavaScript
Star
238
Fork
40
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

At this point the [descriptions of the plugin options](https://github.com/lgeiger/ide-python/blob/master/package.json#L67-L350) visible in the Atom settings are rather basic and often less accurate than what can be found in the documentation of the specific feature provider.

We should improve those descriptions and/or link to the relevant docs if applicable.

Any help on this is highly appreciated. This issue doesn't need to be fixed in one go, we can iteratively improve the plugin documentation.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu với các mô tả tùy chọn plugin trong package.json, đặc biệt là các dòng 67-350, và so sánh từng mục với tài liệu của nhà cung cấp tính năng tương ứng. Cập nhật các mô tả hoặc thêm các liên kết tài liệu liên quan khi chúng không chính xác hoặc quá sơ lược. Công việc được xem là hoàn tất khi các mô tả cài đặt Atom rõ ràng và chính xác hơn đối với các tùy chọn đã xem xét.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript, python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
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

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.