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

skan.csr: Clarify that a skeleton's distances list is initially empty #102

Merged
merged 1 commit into from Nov 15, 2020

Conversation

evan10s
Copy link
Contributor

@evan10s evan10s commented Nov 14, 2020

While working on a project using this library (which has been super helpful!), I noticed that the distances array for my skeleton seemed to contain very small values. Looking at the code, it appears that distances is not initialized until the path_lengths method is called on a skeleton. This is just a small change to indicate this fact in the docs to reduce confusion in the future.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.453% when pulling ff8cff0 on evan10s:master into ef6df1f on jni:master.

@jni
Copy link
Owner

jni commented Nov 15, 2020

Whoa! Thanks for spotting this! Long term we probably want to fix this properly (e.g. distances could become a cached property), but this improves things for now.

Glad you're finding it useful!

@jni jni merged commit f0df976 into jni:master Nov 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants