FlowKit icon indicating copy to clipboard operation
FlowKit copied to clipboard

`subsample_events()` does not return anything

Open hbaniecki opened this issue 1 year ago • 1 comments

Documentation says that subsample_events() returns a numpy array. It does not return any object, nor it changes the dataset attribute in place.

See the appropriate code: https://github.com/whitews/FlowKit/blob/e049a56973bed9b4aa8455d743f4d2e9f4440399/flowkit/_models/sample.py#L370-L417

hbaniecki avatar Oct 07 '22 12:10 hbaniecki

Hi Hubert,

Thanks for catching this outdated docstring. The subsample_events method no longer returns anything. All variations of retrieving events is done through the get_events method. I will correct this for the next version.

Regards, Scott

whitews avatar Oct 13 '22 13:10 whitews