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

[Documentation]: README demos deprecated NwbSegmentationExtractor.write_segmentation #260

Open
2 tasks done
rly opened this issue Nov 9, 2023 · 0 comments
Open
2 tasks done
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@rly
Copy link
Contributor

rly commented Nov 9, 2023

What would you like changed or added to the documentation and why?

This code snippet in the README https://github.com/catalystneuro/roiextractors#data-format-conversion-segmentationextractor-to-nwb
shows how to use NwbSegmentationExtractor.write_segmentation to write a SegmentationExtractor to NWB, but this function 1) no longer has those keyword args and 2) is deprecated in favor of using neuroconv.

Also the deprecation message references nwb_conversion_tools instead of neuroconv.

Suggestion: replace that README snippet with code that converts to NWB using NeuroConv, and update the deprecation message.

Do you have any interest in helping write or edit the documentation?

No.

Code of Conduct

@rly rly added the documentation Improvements or additions to documentation label Nov 9, 2023
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
Projects
None yet
Development

No branches or pull requests

3 participants