Skip to content

Improve primitive help text shown by --list-operations - #124

Merged
matthewhorridge merged 1 commit into
mainfrom
docs/primitive-help-text
Jul 9, 2026
Merged

Improve primitive help text shown by --list-operations#124
matthewhorridge merged 1 commit into
mainfrom
docs/primitive-help-text

Conversation

@matthewhorridge

Copy link
Copy Markdown
Contributor

Summary

  • Rewrites the opening docstring paragraph of all 23 primitives in a consistent imperative voice, with each description naming the operation's serialized settings inline — before/after:
    • offset: "Operator that applies an offset to a numerical value." → "Add a constant offset (number) to numeric values."
    • normalize_text: "Perform a text normalization operation." → "Apply a single text normalization: strip, lower, upper, remove_accents, remove_punctuation, or remove_special_characters."
    • reduce: "Reduction operation that transforms N inputs to 1 output." → "Reduce a list of values to a single value using reduction: any, none, all, one-hot, or sum."
  • Since --list-operations derives its output (and the JSON summary field) from these docstrings, the listing now tells rule authors and AI agents how to configure each operation, not just what it does
  • Detail paragraphs below the summaries are preserved; README sample output updated to match

Test plan

  • pytest tests — 224 passed (spot-check assertion updated to the new convert_units text)

🤖 Generated with Claude Code

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>
@matthewhorridge
matthewhorridge merged commit a4a9280 into main Jul 9, 2026
1 check passed
@matthewhorridge
matthewhorridge deleted the docs/primitive-help-text branch July 9, 2026 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant