SpikeInterface / SpikeInterface/spikeinterface
Improve handling of `coeff` in `filter.py`
@JoeZiminski is already working on this.
Since Jul 23, 2024.
- Dominant language
- Python
- Stars
- 847
- Forks
- 280
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 29
Description
Just a small thing, leaving as a reminder for myself to open a PR after #3172. At present coeff in filter.py takes tuple[np.array] | list[np.array] | np.array | None. This needs reflecting in the docstring, and the numpy array are cast to list in the class constructer but I don't think its necessary, the np.array can be passed directly to the scipy functions.
In general, if an argument can take list[x] | tuple[x] what shall we do? It seems verbose to include both in docstring. Shall we always set to tuple (unless the variable is meant to be mutated in place, which I think is not likely in most cases)?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.