improve: add helpful source_software options to load_dataset errors#858
Open
dhruv1955 wants to merge 1 commit intoneuroinformatics-unit:mainfrom
Open
improve: add helpful source_software options to load_dataset errors#858dhruv1955 wants to merge 1 commit intoneuroinformatics-unit:mainfrom
dhruv1955 wants to merge 1 commit intoneuroinformatics-unit:mainfrom
Conversation
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Description
What is this PR
Why is this PR needed?
When an unsupported
source_softwareis passed toload_dataset, the previous error did not clearly guide users to valid values. This made debugging harder, especially for new users.What does this PR do?
ValueErrormessage inload_datasetto include:source_softwarevalueUnsupported source software)Supported options are:References
No linked issue for this PR.
How has this PR been tested?
ruff check movement/io/load.py tests/test_unit/test_io/test_load.pyload_datasetwith an unknownsource_softwareand confirming the new message includes supported options.tests/test_unit/test_io/test_load.pyfor the new error-message behavior.Is this a breaking change?
No.
This change is backward-compatible and only improves error messaging and related test assertions.
Does this PR require an update to the documentation?
No.
There is no API or usage change; only error clarity is improved.
Checklist: