Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Jan 26, 2026

  • Fix config parameter table keys to use lowercase (buffer_size, parser, threaded) to match docs standards
  • Fix classic config examples to use title case (Name, Format, Regex, Parsers_File)
  • Change code block language from bash to shell for script examples

Fixes #2351

Summary by CodeRabbit

  • Documentation
    • Updated configuration examples to use lowercase key names for consistency
    • Improved code block formatting for clarity

✏️ Tip: You can customize this high-level summary in your review settings.

  - Fix config parameter table keys to use lowercase (buffer_size, parser,
    threaded) to match docs standards
  - Fix classic config examples to use title case (Name, Format, Regex,
    Parsers_File)
  - Change code block language from bash to shell for script examples

Fixes fluent#2351

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Jan 26, 2026
@eschabell eschabell requested a review from a team as a code owner January 26, 2026 11:04
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Jan 26, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 26, 2026

📝 Walkthrough

Walkthrough

Documentation update that standardizes configuration key naming from mixed case (Buffer_Size, Parser, Threaded) to lowercase snake_case (buffer_size, parser, threaded) in the standard input plugin documentation, with code fence language identifier adjustments.

Changes

Cohort / File(s) Summary
Standard Input Documentation Cleanup
pipeline/inputs/standard-input.md
Standardizes configuration parameter keys to lowercase snake_case throughout documentation and examples; updates code fence language identifiers from bash to shell

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • #2330: Standardizes input plugin configuration keys from CamelCase to lowercase_snake_case in documentation
  • #2250: Standardizes configuration key casing (e.g., Threaded → threaded, Parser → parser) across input plugin docs
  • #2275: Modifies documentation around parser configuration including parser/parsers_file keys and examples

Suggested labels

4.2.3

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 A documentation hop,
Keys now lowercase won't stop,
From camelCase to snake so neat,
Consistency makes docs complete!
Snake_case wins the day. 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main changes: documentation fixes for configuration parameter cases and code block formatting in the standard-input documentation.
Linked Issues check ✅ Passed The PR addresses all primary objectives from issue #2351: standardizing configuration parameter keys to lowercase, correcting mixed-case usage in example configurations, and updating code block formatting.
Out of Scope Changes check ✅ Passed All changes are directly related to issue #2351: documentation updates for the standard-input plugin involving configuration key casing, example formatting, and code block language identifiers.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jan 27, 2026
@eschabell eschabell merged commit 4f7355c into fluent:master Jan 27, 2026
8 checks passed
@eschabell eschabell deleted the erics_in_std_input_updates branch January 27, 2026 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standard input plugin doc cleanup needed

2 participants