Skip to content

Conversation

testcara
Copy link
Contributor

pull request template

Improvements for #744


Reviewer Resources:

Track Policies

@testcara testcara changed the title feat: add the "debugging output" for tests.md docs(bash): document fd3 debug output in bats tests Aug 15, 2025
@testcara testcara force-pushed the bat_debug_docs_improvement branch from 292f4e9 to 1ea00ee Compare August 18, 2025 01:27
@testcara
Copy link
Contributor Author

testcara commented Aug 18, 2025

Hi, @glennj , thank you for the review. Comments look great. I have resolved all of them. Now the docs is shown as below:

image

Thank you for your continuous help.

@testcara testcara force-pushed the bat_debug_docs_improvement branch from 1ea00ee to e1a3284 Compare August 18, 2025 01:36
@glennj
Copy link
Contributor

glennj commented Aug 18, 2025

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?

@testcara testcara force-pushed the bat_debug_docs_improvement branch from e1a3284 to c1e5a9b Compare August 19, 2025 01:52
@testcara
Copy link
Contributor Author

testcara commented Aug 19, 2025

Now, it is shown as below:
image

@glennj thank you for your continuous help. BTW, i added one note at the end to mention it just works locally. :-)


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.
Copy link
Contributor

@glennj glennj Aug 19, 2025

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.

Copy link
Contributor Author

@testcara testcara Aug 20, 2025

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.

@testcara testcara force-pushed the bat_debug_docs_improvement branch from c1e5a9b to ea85ce5 Compare August 20, 2025 02:11
@glennj glennj merged commit a970edd into exercism:main Aug 20, 2025
2 checks passed
@glennj
Copy link
Contributor

glennj commented Aug 20, 2025

Thanks @testcara !

@testcara
Copy link
Contributor Author

NP, It’s truly my honor to have the opportunity to contribute here. :-)

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 this pull request may close these issues.

3 participants