Improve primitive help text shown by --list-operations - #124
Merged
Conversation
Rewrite each primitive's opening docstring paragraph in a consistent imperative voice, naming the operation's serialized settings inline (e.g. "Add a constant `offset` (number) to numeric values") so the --list-operations output tells rule authors and AI agents how to configure an operation, not just what it does. Terse "Operator that ..." one-liners are replaced throughout. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
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.
Summary
offset: "Operator that applies an offset to a numerical value." → "Add a constantoffset(number) to numeric values."normalize_text: "Perform a text normalization operation." → "Apply a single textnormalization:strip,lower,upper,remove_accents,remove_punctuation, orremove_special_characters."reduce: "Reduction operation that transforms N inputs to 1 output." → "Reduce a list of values to a single value usingreduction:any,none,all,one-hot, orsum."--list-operationsderives its output (and the JSONsummaryfield) from these docstrings, the listing now tells rule authors and AI agents how to configure each operation, not just what it doesTest plan
pytest tests— 224 passed (spot-check assertion updated to the newconvert_unitstext)🤖 Generated with Claude Code