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 - renamed the uncompress fct to streamlines_to_voxel_coordinates #1103

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

gabknight
Copy link
Contributor

Quick description

For clarity, the uncompress(.) function was renamed streamlines_to_voxel_coordinates.

The module remains named scilpy.tractogram.uncompress.

...

Type of change

Check the relevant options.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Provide data, screenshots, command line to test (if relevant)

...

Checklist

  • My code follows the style guidelines of this project (run autopep8)
  • I added relevant citations to scripts, modules and functions docstrings and descriptions
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I moved all functions from the script file (except the argparser and main) to scilpy modules
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@pep8speaks
Copy link

pep8speaks commented Dec 12, 2024

Hello @gabknight, Thank you for updating !

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2025-01-09 20:38:12 UTC

@gabknight gabknight force-pushed the DOC_uncompress_streamline branch from 8568800 to 4ff7eff Compare December 12, 2024 20:00
EmmaRenauld
EmmaRenauld previously approved these changes Dec 18, 2024
Copy link
Contributor

@EmmaRenauld EmmaRenauld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (when tests pass)

@@ -12,7 +12,7 @@ cimport numpy as cnp

cdef struct Pointers:
# Incremented when we complete a streamline. Saved at the start of each
# streamline because we need to start anew if we resize data_out
# streamline because we need to start a new if we resize data_out
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that anew was ok.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, fixed :)

@gabknight gabknight force-pushed the DOC_uncompress_streamline branch from 4ff7eff to e934874 Compare January 9, 2025 20:31
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.

4 participants