docs: add top-level descriptions to Bloblang methods#414
Conversation
|
Commits Review
|
|
Commits
Review LGTM |
|
|
|
Commits
Review 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>
915af65 to
61c1db1
Compare
|
Commits Review LGTM |
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:
Files Changed
internal/bloblang/query/methods.go- Type coercion methodsinternal/bloblang/query/methods_strings.go- String manipulation, parsing, regex, and encoding methodsinternal/bloblang/query/methods_structured.go- Array and object manipulation methodsTest Plan
go test ./internal/bloblang/query/...)Examples
Before:
After:
🤖 Generated with Claude Code