Update help documentation to reflect that `smooth_frames` isn't only applied for signals with multiple `samps_per_frame`
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 853
- Forks
- 322
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Durchsicht der Hilfedokumentation und der Parameterbeschreibungen für smooth_frames, und vergleiche sie anschließend mit dem durch Pull Request #313 geänderten Verhalten. Aktualisiere die Dokumentation so, dass sie nicht mehr besagt, dass die Glättung auf Signale mit einem anderen samps_per_frame als 1 beschränkt ist, und stelle sicher, dass jede Beschreibung des Glättungsverfahrens dem aktuellen Verhalten entspricht.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100