-
Notifications
You must be signed in to change notification settings - Fork 370
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
Fix output of nest.spatial in Read the Docs #2527
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@med-ayssar Thanks for looking into this, I just checked the output, and it looks like its all there 🎉
I think in a separate PR we can look at combining the two spatial sections of the API
What do you mean by combining here? I think that I am missing some context. |
There is nest.spatial and nest.lib.spatial - and these are separate sections in Read the Docs API, for "spatially-distributed nodes" and "spatial distributions", which is a bit confusing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have just a couple suggestions for the code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should avoid that distance
is created at import time, which we can do by moving this logic to nest.spatial
I'm also highly in favor of merging the 2 modules! It's confusing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. nest.spatial.distance
works, import time code is avoided and the docs render and reference to distance just fine.
Fixes #2513