stumpy icon indicating copy to clipboard operation
stumpy copied to clipboard

Incorrect descriptions in Docstrings

Open NimaSarajpoor opened this issue 3 years ago • 2 comments

I have been reading the module mpdist and I noticed:

  • The description of the output of _mpdist_vect is missing from its docstring
  • The description of μ_Q and σ_Q (in _mpdist_vect) are not correct. I think they should be numpy.ndarrays not float.
  • The description of μ_Q and σ_Q (in core. _mass_distance_matrix) are not correct. I think they should be numpy.ndarrays not float.

NimaSarajpoor avatar Jul 31 '22 23:07 NimaSarajpoor

Thanks for identifying this @NimaSarajpoor. I just took a look and I think you are correct. Would you mind submitting a PR to address this?

seanlaw avatar Aug 01 '22 01:08 seanlaw

Sure, I will do so in a day or two.

NimaSarajpoor avatar Aug 01 '22 05:08 NimaSarajpoor