Skip to content

docs: add top-level descriptions to Bloblang methods#414

Merged
josephwoodward merged 1 commit intomainfrom
feat/add-bloblang-descriptions
Apr 2, 2026
Merged

docs: add top-level descriptions to Bloblang methods#414
josephwoodward merged 1 commit intomainfrom
feat/add-bloblang-descriptions

Conversation

@JakeSCahill
Copy link
Copy Markdown
Contributor

Summary

Adds concise top-level descriptions to 67 Bloblang methods that previously only had category-level descriptions. This improves documentation clarity and helps users understand method purposes at a glance when viewing method lists or API documentation.

Changes

All descriptions follow active voice, present tense, and concise writing standards from the Redpanda documentation style guide.

Methods updated across six categories:

  • Type Coercion (9): array, bool, bytes, not_empty, not_null, number, string, timestamp, type
  • String Manipulation (25): capitalize, decode, encode, escape_html, escape_url_path, escape_url_query, format, format_json, format_yaml, has_prefix, has_suffix, index_of, join, lowercase, quote, repeat, replace_all, replace_all_many, reverse, split, trim, trim_prefix, trim_suffix, unquote, uppercase
  • Parsing & Formatting (4): parse_csv, parse_json, parse_logfmt, parse_yaml
  • Regular Expressions (6): re_find_all, re_find_all_object, re_find_all_submatch, re_find_object, re_match, re_replace_all
  • Object & Array Manipulation (13): collapse, contains, explode, filter, length, map_each, map_each_key, reverse, slice, sort, sort_by, sum, unique, values, without
  • Encoding & Other (10): decrypt_aes, encrypt_aes, filepath_join, filepath_split, hash, unescape_html, unescape_url_path, unescape_url_query, uuid_v5

Files Changed

  • internal/bloblang/query/methods.go - Type coercion methods
  • internal/bloblang/query/methods_strings.go - String manipulation, parsing, regex, and encoding methods
  • internal/bloblang/query/methods_structured.go - Array and object manipulation methods

Test Plan

  • All existing tests pass (go test ./internal/bloblang/query/...)
  • No breaking changes to existing functionality
  • Descriptions follow documentation standards (active voice, present tense, concise)

Examples

Before:

NewMethodSpec("bool", "").InCategory(...)

After:

NewMethodSpec("bool", "Converts a value to a boolean with optional fallback").InCategory(...)

🤖 Generated with Claude Code

@claude
Copy link
Copy Markdown

claude bot commented Apr 2, 2026

Commits
LGTM

Review
Documentation-only PR adding top-level descriptions to 67 Bloblang methods. Most descriptions are accurate and well-written. Two descriptions are factually incorrect and will mislead users.

  1. collapse description is incorrect — says "Flattens nested arrays by one level" but the method actually flattens nested structures into a single-level object with dot-notation keys.
  2. explode description is incorrect — says "Converts an array of key-value pairs into an object" but the method actually expands a nested array or object field into multiple documents.

@claude
Copy link
Copy Markdown

claude bot commented Apr 2, 2026

Commits

  1. docs: add top-level descriptions to Bloblang methods — "docs" is not a known system area per the commit message format policy. The prefix should reference the actual component being changed, e.g., bloblang: add top-level descriptions to methods.
  2. fix: improve accuracy of method descriptions — Same issue: "fix" is not a system name. Per the policy, the action verb belongs in the message portion, e.g., bloblang: improve accuracy of method descriptions.

Review
All changes are documentation-only: adding description strings to NewMethodSpec() calls. No logic, behavior, or API changes.

LGTM

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@claude
Copy link
Copy Markdown

claude bot commented Apr 2, 2026

Commits

  1. All three commits use conventional commit prefixes (docs:, fix:) instead of the required system name format. Since all changes are in internal/bloblang/query/, the prefix should be bloblang: (e.g., bloblang: add top-level descriptions to methods).
  2. Commits 2 (fix: improve accuracy of method descriptions) and 3 (fix: correct map_each and map_each_key descriptions) are corrections to the descriptions added in commit 1. These should be squashed into the first commit rather than kept as separate follow-up fixes within the same PR.

Review
All changes are purely documentation — adding descriptive strings as the second argument to NewMethodSpec() calls that were previously empty. No functional code is modified.

LGTM

Adds concise top-level descriptions to 67 Bloblang methods that previously
only had category-level descriptions. This improves documentation clarity
and helps users understand method purposes at a glance.

Methods updated span six categories:
- String Manipulation (35)
- Type Coercion (6)
- Object & Array Manipulation (14)
- Encoding and Encryption (6)
- Parsing (4)
- Regular Expressions (6)

All descriptions follow active voice, present tense, and concise writing
standards from the Redpanda documentation style guide.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@JakeSCahill JakeSCahill force-pushed the feat/add-bloblang-descriptions branch from 915af65 to 61c1db1 Compare April 2, 2026 09:22
@claude
Copy link
Copy Markdown

claude bot commented Apr 2, 2026

Commits
LGTM

Review
Pure documentation change adding top-level description strings to 67 Bloblang method specs across three files. All changes are string literal additions with no logic modifications.

LGTM

@josephwoodward josephwoodward merged commit adf6163 into main Apr 2, 2026
3 of 4 checks passed
@josephwoodward josephwoodward deleted the feat/add-bloblang-descriptions branch April 2, 2026 10:06
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.

3 participants