docstring for computeOnsOffs.m is totally wrong

[qliu-Inscopix]

docstring for computeOnsOffs.m is totally wrong

[sg-s]

no, because x is assumed to be binary (logical)

[qliu-Inscopix]

missing threshold argument in the function body:

veclib.computeOnsOffs([-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0]) will return [];

veclib.computeOnsOffs([-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0], -5) gives the "Too many input arguments." error:

[sg-s]

veclib.computeOnsOffs([-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0]) will return [];

yes, because this is a monotonic sequence -- there are no ons or offs

veclib.computeOnsOffs([-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0], -5)

yes, because it only takes one argument -- a (logical) vector.

what you want to do is:

veclib.computeOnsOffs([-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0] > -5)

[qliu-Inscopix]

OK, a simple update to the help doc should avoid using a second argument

[sg-s]

ah i see the docstring is totally wrong. my bad!

[sg-s]

@qliu-Inscopix FYI you will find the docstrings generally unreliable -- ping me if you find something missing/out of sync

[qliu-Inscopix]

Will do!

…

On Mon, Aug 29, 2022 at 3:56 PM Srinivas Gorur-Shandilya < ***@***.***> wrote: @qliu-Inscopix <https://github.com/qliu-Inscopix> FYI you will find the docstrings generally unreliable -- ping me if you find something missing/out of sync — Reply to this email directly, view it on GitHub <#112 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ATBLRFH444P57I45QYH2X4TV3UIV5ANCNFSM542FSKQA> . You are receiving this because you were mentioned.Message ID: ***@***.***>