Documentation missing regarding INotify Watcher implementation
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 55/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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
- 主要语言
- Python
- 星标
- 1.1k
- 派生
- 149
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
lepture/python-livereload 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 70/100
lepture/python-livereload#159 · 3 个 reaction ·
-
难度 4/5 3-5 天 新手友好度 35/100
lepture/python-livereload#288 ·
-
难度 3/5 1-2 天 新手友好度 38/100
lepture/python-livereload#283 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 25/100
lepture/python-livereload#282 ·
-
难度 4/5 3-5 天 新手友好度 25/100
lepture/python-livereload#279 ·
查看 lepture/python-livereload 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
omegaup/omegaup#10353 · 1 条评论 ·
维护者通常 5 天内回复
-
bot-triaged module: LrScheduler module: optimizer triaged
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
documentation glm5 llm-model
难度 2/5 1-3 小时 新手友好度 78/100
vllm-project/vllm-ascend#19062 ·
维护者通常 1 天内回复
-
author-page correction
难度 2/5 1-3 小时 新手友好度 68/100
acl-org/acl-anthology#10496 · 1 条评论 ·
维护者通常 1 天内回复