Documentation missing regarding INotify Watcher implementation
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 55/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Python
- Stelle
- 1.1k
- Fork
- 149
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di lepture/python-livereload
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 70/100
lepture/python-livereload#159 · 3 reazioni ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
lepture/python-livereload#288 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 38/100
lepture/python-livereload#283 · 1 commento ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
lepture/python-livereload#282 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
lepture/python-livereload#279 ·
Tutte le issue di lepture/python-livereload
Issue simili
-
python triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
microsoft/semantic-kernel#14590 ·
I maintainer di solito rispondono entro 3 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
pinterest/pymemcache#662 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 Mezza giornata Idoneità per principianti 62/100
gnocchixyz/gnocchi#1527 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
tenstorrent/tt-model-manager#181 ·
I maintainer di solito rispondono entro 1 giorno