-
Notifications
You must be signed in to change notification settings - Fork 409
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
Test cat formatter and update usage string #710
Test cat formatter and update usage string #710
Conversation
andregri
commented
Mar 4, 2023
- I have reviewed the Contributor Guidelines.
- I have reviewed the Code of Conduct and agree to abide by it
Thank for your suggestion. The cat formatter is intended as an internal debugging tool and as such not documented. Could you motivate why documentation and tests are warranted for this? |
Since the cat formatter is supported by bats, it should be documented for developers or contributors. Maybe it would be better to improve the PR by adding a bit of documentation to specify that is used as an internal tool. Even if it is an internal / debugging tool, I think that tests acts like documentation for contributors. Eventually i added tests for completeness. |
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.
Following our previous discussion I reviewed the Code and have following suggestions:
- Documentatiin of this formatter should only be provided in the contributor guide
- AFAIK the only part of this formatter that is not already tested is that it prints the extended tap stream.
Should we document cat formatter in CONTRIBUTING.md, for instance under "Testing" section ? Or should we add
To test the extended tap stream with the cat formatter I used the same input as the test "All formatters (except cat) implement the callback interface" in formatter.bats. |
I'd put it into contributing.md |
I wrote few lines under the Testing section. Since it is a debugging tool, I think it may be useful to read about the cat formatter during testing. |
Thanks for your contribution. |