Add #examples and #examplesDictionary macros to DRY up rule description#6794
Open
ZevEisenberg wants to merge 1 commit into
Open
Add #examples and #examplesDictionary macros to DRY up rule description#6794ZevEisenberg wants to merge 1 commit into
ZevEisenberg wants to merge 1 commit into
Conversation
Generated by 🚫 Danger |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
When I wrote the
Exampletype in #3040, it improved the experience of writing and debugging a rule (because test failures would point at precisely the example case that failed the test). But it came at the expense of a lot of repetitiveExample("...")call sites.Now that macros exist, I propose using them to keep the benefits of
Example(that is, using file names and line numbers to surface test failures) while cleaning up the call sites. The new macros transform[String]and[String: String]to[Example]and[Example: Example], respectively.If it's helpful for review, here's a Claude-generated script that confirms that the changes to the rule files are just adding the macro and removing the
Examplewrapper:review_mechanical_changes.py
Alternatives/Questions
replacethe entire init of RuleDescription. But this seemed like an overreach, and would prevent falling back to passing variables or non-literals, which limits flexibility and experimentation.#examples, but that seemed too cute and not clear enough at the point of use.