Update help documentation to reflect that `smooth_frames` isn't only applied for signals with multiple `samps_per_frame`
Personne n'a encore pris cette issue.
- Langage dominant
- Jupyter Notebook
- Étoiles
- 853
- Forks
- 322
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner la documentation d’aide et les descriptions des paramètres de smooth_frames, puis comparez-les au comportement modifié par la pull request #313. Mettez à jour la documentation afin qu’elle n’indique plus que le lissage est limité aux signaux dont samps_per_frame est différent de 1, et assurez-vous que toute description de la procédure de lissage corresponde au comportement actuel.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100