Use a single `path` argument (and deprecate `pn_dir` and `file_name`)
Nessuno ha ancora preso questa issue.
- Lingua principale
- Jupyter Notebook
- Stelle
- 853
- Fork
- 322
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Currently the WFDB API uses 2 arguments to specify the location of files: pn_dir and file_name. This is confusing for users and confusing for developers (e.g. see: https://github.com/MIT-LCP/wfdb-python/pull/523/files).
I think the reason for having two arguments is to support auto-detection of files (e.g. get locally if local and if not get from the PhysioNet servers). This kind of behaviour doesn't seem like a good idea. If WFDB is retrieving a remote file, it should be explicit.
My preference would be to:
- Introduce a new
pathargument - Deprecate
pn_dirandfile_name - Remove any logic that automatically retrieves files from remote servers.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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.
Direzione di ricerca
Inizia tracciando i punti di ingresso dell’API WFDB che accettano pn_dir e file_name, quindi individua la logica che recupera automaticamente i file dai server PhysioNet. Definisci le chiamate interessate e il comportamento di compatibilità prima di modificarle. Il lavoro è completato quando è supportato un singolo argomento path, gli argomenti precedenti sono deprecati e il recupero remoto implicito è stato rimosso.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- backend-api-design
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100