Clarify how to run files not on the MATLAB path #10
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
mcafaro
reviewed
Apr 13, 2021
README.md
Outdated
| MATLAB exits with exit code 0 if the specified script, function, or statement executes successfully without error. Otherwise, MATLAB terminates with a nonzero exit code, which causes the build to fail. To ensure that the build fails in certain conditions, use the [`assert`](https://www.mathworks.com/help/matlab/ref/assert.html) or [`error`](https://www.mathworks.com/help/matlab/ref/error.html) functions. | ||
|
|
||
| When you use this action, all of the required files must be on the MATLAB search path. | ||
| When you use this action, all of the required files must be on the MATLAB search path. If your script or function is located in a folder in the root of your repository, you can use the [`addpath`](https://www.mathworks.com/help/matlab/ref/addpath.html), [`cd`](https://www.mathworks.com/help/matlab/ref/cd.html), or [`run`](https://www.mathworks.com/help/matlab/ref/run.html) functions to ensure that the folder is on the path when the script or function is invoked. For example, to run `myscript.m` in a folder `myfolder` in the root of the repository, you can specify `command` like this: |
Member
There was a problem hiding this comment.
I first read this as "If your script or function is located in the root folder..."
Would it be clearer to say "If your script or function is not located in the root folder of your repository, ..." ?
Member
Author
There was a problem hiding this comment.
Yes, I think this conveys the message more clearly. Updated the paragraph.
mcafaro
approved these changes
Apr 14, 2021
jwpereira
approved these changes
May 14, 2021
Contributor
jwpereira
left a comment
jwpereira
left a comment
There was a problem hiding this comment.
I just realized I never approved this even though I absolutely have 😅
My b; 🚢
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.
No description provided.