-
-
Notifications
You must be signed in to change notification settings - Fork 93
docs(bash): document fd3 debug output in bats tests #748
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
Conversation
292f4e9
to
1ea00ee
Compare
Hi, @glennj , thank you for the review. Comments look great. I have resolved all of them. Now the docs is shown as below: ![]() Thank you for your continuous help. |
1ea00ee
to
e1a3284
Compare
Since redirecting to fd 3 seems to break tests on the test runner, is it worthwhile to mention that this only works for testing locally (not in the online editor)? @IsaacG what do you think? |
e1a3284
to
c1e5a9b
Compare
@glennj thank you for your continuous help. BTW, i added one note at the end to mention it just works locally. :-) |
exercises/shared/.docs/tests.md
Outdated
|
||
This allows you to see helpful debug output without affecting the tests. | ||
|
||
⚠️Note: This works locally with `bats`, but **not** in the Exercism online editor. |
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.
Let's stick with the Exercism style of notes. Please see https://exercism.org/docs/building/markdown/markdown#h-special-blocks-sometimes-called-admonitions
We might use exercism/caution
for this.
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.
Updated. and put it under the 'Debugging output' header for better user experience. Thank you, Glenn.
c1e5a9b
to
ea85ce5
Compare
Thanks @testcara ! |
NP, It’s truly my honor to have the opportunity to contribute here. :-) |
pull request template
Improvements for #744
Reviewer Resources:
Track Policies