Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Incorrect descriptions in Docstrings #652

Closed
NimaSarajpoor opened this issue Jul 31, 2022 · 2 comments
Closed

Incorrect descriptions in Docstrings #652

NimaSarajpoor opened this issue Jul 31, 2022 · 2 comments
Labels
communication and transparency documentation enhancement

Comments

@NimaSarajpoor
Copy link
Collaborator

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 NimaSarajpoor changed the title Incorrect descriptions in Docstring Incorrect descriptions in Docstrings Jul 31, 2022
@seanlaw
Copy link
Contributor

seanlaw commented Aug 1, 2022

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?

@NimaSarajpoor
Copy link
Collaborator Author

NimaSarajpoor commented Aug 1, 2022 •
edited

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

@NimaSarajpoor NimaSarajpoor mentioned this issue Aug 1, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
communication and transparency documentation enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@seanlaw @NimaSarajpoor