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

[JOSS Review] - Suggestions for configuration documentation #3

Closed
ericfell opened this issue Oct 29, 2024 · 2 comments · Fixed by #8
Closed

[JOSS Review] - Suggestions for configuration documentation #3

ericfell opened this issue Oct 29, 2024 · 2 comments · Fixed by #8

Comments

@ericfell
Copy link

ericfell commented Oct 29, 2024

Dear authors,

In the README's Configuration section, can you provide further documentation that covers the situation where a user wants to configure multiple devices and use them together (i.e. multiple COM ports being used)?
A short code example where multiple devices are configured in a single config.ini file could go just below the single-device example shown at https://cohesivm.readthedocs.io/en/latest/getting_started/configuration.html

Configuring new devices will likely be the situation where significant bugs/troubleshooting could occur, and thus significant documentation/examples will benefit all users.

This issue is related to openjournals/joss-reviews#7291

@mxwalbert
Copy link
Owner

Dear @ericfell,
thank you for this suggestion. We added an example in the README's configuration section.
Please confirm if this gives a clearer picture of the configuration.

@ericfell
Copy link
Author

Yes it does, thank you for adding this example.
I'll close this issue

@mxwalbert mxwalbert linked a pull request Jan 3, 2025 that will close this issue
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 a pull request may close this issue.

2 participants