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

Add explanation in README for new functions in PR#6 #11

Open
buscandoaverroes opened this issue Feb 6, 2024 · 0 comments · May be fixed by #26
Open

Add explanation in README for new functions in PR#6 #11

buscandoaverroes opened this issue Feb 6, 2024 · 0 comments · May be fixed by #26
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@buscandoaverroes
Copy link
Contributor

buscandoaverroes commented Feb 6, 2024

Is your feature request related to a problem? Please describe.
There is no guide on how to use the functions that were added in PR#6.

Describe the solution you'd like
Add a brief explanation of each of

  • GetNspatialIdsAroundVoxcels()
  • GetSpatialIdsWithinRadiusOfLine()
  • FitClearanceAroundExtendedSpatialID()

and a code-based example of how to use them. The explanation should include how to use each of the parameters.

Additional context
Also, add speed performance of GetSpatialIdsWithinRadiusOfLine

@buscandoaverroes buscandoaverroes added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 6, 2024
@buscandoaverroes buscandoaverroes self-assigned this Feb 6, 2024
@buscandoaverroes buscandoaverroes linked a pull request Jun 24, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant