Modify contributing md scripts to solve conflicts between doc and scripts #2107
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.
Pull Request Template
Checklist
run-checks all
script has been executed.Related Issues/PRs
Fixes #2106
Changes
1.no_std is typo, but it should be no-std
no_std is typo, but it should be no-std
The doc tell that there are only two environment of std and no-std, but it now includes four environments due to script.
2.environment values
“If no
environment
value has been passed, run bothstd
andno_std
checks”, this is incorrect because when I use the script without environment args, it causes an error as follow.It is because the implementation and docs are different. As of now, I believe script comments are correct and modify the codes by modifying default value so as to keep
All
as it is and executes checks except examples. But if you prefer to others, I will follow it, so please let me know.3.torch installation.
I got in trouble when executing
./run-checks.sh all
because I have never installed torch on my pc. It is because./run-checks.sh all
executescrates/burn-tch
and it requires torch installation. Therefore, adding the link ofcrates/burn-tch
will definitely help developers like me to solve the issue, so I added the link on theCONTRIBUTING.md
.Testing
I run
./run-check.sh
and checked outAll
is executed.