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.

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

[doc] missing data index value in KDTree, cKDTree #5750

Closed
Carreau opened this issue Jan 21, 2016 · 5 comments
Closed

[doc] missing data index value in KDTree, cKDTree #5750

Carreau opened this issue Jan 21, 2016 · 5 comments
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution scipy.spatial
Milestone

Comments

@Carreau
Copy link
Contributor

Carreau commented Jan 21, 2016

cKDtree says Missing neighbors are indicated with self.n. though self.n is not documented (AFAICT as being len(data)

KDTree does not mention anything about missing indices, but seem to do the same.

@rgommers rgommers added scipy.spatial Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution labels Jan 23, 2016
@rgommers
Copy link
Member

Documenting n as a public attribute would be good. And also checking for other missing attributes in the docs.

@gfyoung
Copy link
Contributor

gfyoung commented Jan 31, 2016

Ignore that commit. I meant to address #5751. Can look at this one in a separate PR though.

@goelakash
Copy link

I would like to work on this. So:

  1. adding a mention of n as equivalent to size of tree in attribute list in both kdtree,py and ckdtree.pyx
  2. adding "Missing parameters are indicated by self.n" in KDTree.py

anything else that should/shouldn't be done?

@rgommers
Copy link
Member

@goelakash sure, you're welcome to work on this. Don't bother with KDTree though, only cKDTree - we're going to be deprecating the former. I think what's needed here is adding a list of all public attributes in the main cKDTree docstring with an explanation of what they're for. See https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#class-docstring for theAttributes`` format.

@rgommers
Copy link
Member

rgommers commented Jan 7, 2017

Fixed in gh-6939, thanks all.

@rgommers rgommers closed this as completed Jan 7, 2017
@rgommers rgommers added this to the 0.19.0 milestone Jan 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution scipy.spatial
Projects
None yet
Development

No branches or pull requests

4 participants