matchtree: switch to enum for matches signature #691
Merged
Conversation
This file contains 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
camdencheek
reviewed
Nov 14, 2023
The pair of bools (matches, sure) often was quite hard to reason about. I think this came down to them often not being named at return sites, the names itself being too concise and that two booleans represents 4 possible states, but we only had two possible states. This commit uses a more verbose enum instead of booleans. From reading the diff back I find the code easier to reason about, so I think this is a good change. Test Plan: go test ./...
keegancsmith
changed the title
|
Alright I have added a bunch of documentation and re-reviewed the code to make sure it is correct. Looking for more eyes :) |
stefanhengl
approved these changes
Nov 15, 2023
No, but all these code paths get covered normally. I can do a coverage test? But indeed a change like this is a bit scary so I personally reviewed it like three times :) |
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.
The pair of bools (matches, sure) often was quite hard to reason about. I think this came down to them often not being named at return sites, the names itself being too concise and that two booleans represents 4 possible states, but we only had two possible states.
This commit uses a more verbose enum instead of booleans. From reading the diff back I find the code easier to reason about, so I think this is a good change.
Test Plan: go test ./...