Update help documentation to reflect that `smooth_frames` isn't only applied for signals with multiple `samps_per_frame`
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
Pull request #313 changes the behavior of smooth_frames such that it can be used to create a uniformly sampled array or a list of signals even when their samps_per_frame = 1. The help documentation states that smooth_frames is only used when samps_per_frame is not 1. This should be updated to reflect the new behavior. Any updates made to the parameter descriptions regarding how the smoothing procedure works should also be reflected in the help documentation.
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 esaminando la documentazione della guida e le descrizioni dei parametri di smooth_frames, quindi confrontale con il comportamento modificato dalla pull request #313. Aggiorna la documentazione in modo che non affermi più che lo smoothing è limitato ai segnali con samps_per_frame diverso da 1 e assicurati che qualsiasi descrizione della procedura di smoothing corrisponda al comportamento attuale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100