Document what each formatter does #5313
Merged
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
ybiquitous
reviewed
May 18, 2021
There was a problem hiding this comment.
I think it so good to add the explanations for each formatter. 👏🏼
But, one sentence paragraph seems a bit hard for me to read visually.
Does it make sense to add the explanations to the list as follows?
- `string` (default For CLI) - generates human-readable strings.
- `tap` - generates [Test Anything Protocol](http://testanything.org/) output.
|
Much neater suggestion. It also highlighted that I'd forgotten about the |
ybiquitous
approved these changes
May 19, 2021
There was a problem hiding this comment.
@jeddy3 Thank you. This improvement should be so helpful for everyone! 🙌🏼
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.
Closes #5278
Just tying up a few loose ends.