Documentation missing regarding INotify Watcher implementation
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 55/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Start with livereload/watcher.py around line 168 to confirm how pyinotify is selected and when the polling implementation is used. Find the repository's existing documentation location, then document the opt-in and opt-out behavior and how it relates to missed changes. Done means users can understand which watcher is active and how pyinotify availability affects debugging.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Documentation should be updated to explain that the library will prefer to use pyinotify if available, and if not will use it's own implementation that performs polling. This allows end-users of the library to opt-in to pyinotify but having it available for import, or optionally disabling it by not having it available.
This is useful information to those debugging problems related to missed changes.
Relevant code: https://github.com/lepture/python-livereload/blob/master/livereload/watcher.py#L168
- Ngôn ngữ chính
- Python
- Star
- 1.1k
- Fork
- 149
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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.
Issue khác của lepture/python-livereload
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 70/100
lepture/python-livereload#159 · 3 reaction ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
lepture/python-livereload#288 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 38/100
lepture/python-livereload#283 · 1 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
lepture/python-livereload#282 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
lepture/python-livereload#279 ·
Tất cả issue của lepture/python-livereload
Issue tương tự
-
SSM GetParameter throttling during concurrent workflow launchesCó thể đã có người làm @alexiswl đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 80/100
-
[Bug] Dev image build fails: `npm install` in the root Dockerfile runs out of memory (exit 134)Có thể đã có người làm @andest01 đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 79/100
pesu-dev/discord_bot#97 ·
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
gradio-app/gradio#13964 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 93/100
BSData/horus-heresy-3rd-edition#3232 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày