Update help documentation to reflect that `smooth_frames` isn't only applied for signals with multiple `samps_per_frame`
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 853
- Forks
- 322
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando la documentación de ayuda y las descripciones de los parámetros de smooth_frames, y compáralas después con el comportamiento modificado por el pull request #313. Actualiza la documentación para que ya no indique que el suavizado está limitado a señales con un valor de samps_per_frame distinto de 1, y asegúrate de que cualquier descripción del procedimiento de suavizado coincida con el comportamiento actual.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100