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

Added info about what id is for device config about YAML for CLI #88

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

hsemwal
Copy link

@hsemwal hsemwal commented Dec 12, 2024

Added description to device config id in stream.py about id for CLI "This is currently the id located in the first line of the YAML config file "


📚 Documentation preview 📚: https://miniscope-io--88.org.readthedocs.build/en/88/

@coveralls
Copy link
Collaborator

Coverage Status

coverage: 79.112%. remained the same
when pulling 79d6ea3 on docs_cli_stream_help
into 920d795 on main.

@sneakers-the-rat
Copy link
Collaborator

Is this not covered by saying the id field? Though on load the id is moved to the front, it would still work if it wasn't the first line in the file.

@sneakers-the-rat
Copy link
Collaborator

sneakers-the-rat commented Dec 12, 2024

Or I guess another way of asking, what else would "Config id" mean so we can correct the ambiguity without overspecifying it by position in the file?

@hsemwal
Copy link
Author

hsemwal commented Dec 12, 2024

For someone (like me) who isn't familiar with what different terms are (or how they're getting called), I had no idea. Is ID individual miniscope ID? Is it a type of miniscope (i.e. distinguishing between miniSTIM and Wirefree). Also I was surprised it can be called by the CLI.

I also don't have a good suggestion about what it could be called in the future.

The following: "Either a config id or a path to device config YAML file for streamDaq " is good for commenting, but just wanted to bring attention to how it is being interpreted on user end.

@sneakers-the-rat
Copy link
Collaborator

sneakers-the-rat commented Dec 12, 2024

totally ya want to clarify what is unclear to ppl as they are learning what's going on.

So when you saw "either a config id or path to device config YAML file" what did you think it meant, and what cleared it up?

Is ID individual miniscope ID?

Since this is CLI docs we can't do what we would normally do which is link to the Mixin.id field directly or to the config docs page, so would something like "id field in a config file" be clearer?

Now that both the config cli PR and the "all configs are yaml now" PR are both merged, we could have like a mio config --list to show all the config ids that exist so you know what there is to choose from.

Also I was surprised it can be called by the CLI.

Not sure what you mean here, what can be called by the cli?

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.

3 participants