-
Notifications
You must be signed in to change notification settings - Fork 32
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] Describe what bids-matlab can and cannot do #84
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this, @Remi-Gau!
- Octave 5.2.0 or newer | ||
- MATLAB R2014a or newer | ||
|
||
We aim for compatibility with the latest stable release of Octave at any time. Compatibility can sometimes also be achieved with older versions of Octave but this is not guaranteed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We aim for compatibility with the latest stable release of Octave at any time. Compatibility can sometimes also be achieved with older versions of Octave but this is not guaranteed. | |
We aim for compatibility with the latest stable major version of Octave at any time. Compatibility can sometimes also be achieved with older versions of Octave but this is not guaranteed. |
Maybe you should declare support for a full major version series like Octave 5.x instead of just the "latest stable release", which could be interpreted as "exactly 5.2.3" or similar.
Maybe declare a policy about how long Octave major versions are supported? For example, Octave 6.x is right around the corner. How long will you support Octave 5.x once 6.x is out?
And what about a policy for how long older Matlab versions are supported? If you support R2014a forever, you're eventually going to have a lot of Matlab versions to test against, and you'll never get to adopt newer Matlab features.
Co-authored-by: Andrew Janke <[email protected]>
This should fix #77.
Main change
This adds a very generic description of what the toolbox can do and what functions do it, as this was pointed out as one of the obvious missing point in documentation.
Minor change
Adds some details about our "philosophy" of what Octave / Matlab version we support.
For reviewers
layout
,query
,report
and not the internal functions.