Parameter `T_subseq_isconstant` in `core.process_isconstant` should be set to `None` as default

Question

Parameter `T_subseq_isconstant` in `core.process_isconstant` should be set to `None` as default

Closed this issue a year ago · 3 comments

The docstring says:

T_subseq_isconstant : numpy.ndarray, function, or list, default None

However, the parameter is not set to None.

https://github.com/TDAmeritrade/stumpy/blob/3077d0ddfb315464321dc86f8ec3bf2cab9ce3b1/stumpy/core.py#L4224-L4244

Answer 1 · 2024-07-23T01:07:48.000Z

@NimaSarajpoor Perhaps we should update the docstring and remove , default None?

Answer 2 · 2024-07-23T02:15:06.000Z

This function returns T_subseq_isconstant and thus, it may make sense to allow users to only pass T and m (and nothing else) if they want to capture constant subsequences.

So, I think we just set it to None as default. What do you think?

Answer 3 · 2024-07-23T04:47:28.000Z

@NimaSarajpoor That sounds fine. Change it and run the tests again to see if anything breaks