[#33] Split the 'ToolCheckResult' constructor #65
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
chshersh
requested changes
Aug 21, 2022
src/Iris/Tool.hs
Outdated
| data ToolCheckResult | ||
| {- | | ||
| @since 0.0.0.1 |
Owner
There was a problem hiding this comment.
I prefer to use @since x.x.x.x for new unreleased changes. I'll update CONTRIBUTING guide, mentioning this workflow. But the motivation is that the new version is not known at the moment of introducing new change. So we can write x.x.x.x and later replace all such places with a single shell command.
Suggested change
| @since 0.0.0.1 | |
| @since x.x.x.x |
In this case, it's a breaking change, so the new Iris version already will be 0.1.0.0. Still, it's better to follow some practices 😌
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.
Might have slipped up with denoting versions in the comments -- will be glad to hear remarks!