Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Jan 22, 2026

  • Sort configuration parameters alphabetically
  • Change parameter names to lowercase to match other input plugin docs
  • Fix inconsistent casing in classic config example (Interval_NSec -> Interval_Nsec)
  • Update table header alignment to match other docs
  • Shorten descriptions to match documentation style conventions

Fixes #2342

Summary by CodeRabbit

  • Documentation
    • Configuration keys have been standardized to lowercase snake_case naming convention (e.g., Samplessamples, Interval_Secinterval_sec).
    • Updated all configuration examples and documentation to align with the new key naming format.

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

  - Sort configuration parameters alphabetically
  - Change parameter names to lowercase to match other input plugin docs
  - Fix inconsistent casing in classic config example (Interval_NSec -> Interval_Nsec)
  - Update table header alignment to match other docs
  - Shorten descriptions to match documentation style conventions

Fixes fluent#2342

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

coderabbitai bot commented Jan 22, 2026

📝 Walkthrough

Walkthrough

This pull request updates the random input plugin documentation by standardizing configuration parameter keys from capitalized formats (Samples, Interval_Sec, Interval_Nsec, Threaded) to consistent lowercase snake_case (samples, interval_sec, interval_nsec, threaded), with corresponding updates to descriptions and examples throughout the documentation.

Changes

Cohort / File(s) Summary
Configuration key normalization
pipeline/inputs/random.md
Renamed all configuration parameter keys to lowercase snake_case, updated configuration examples (YAML and INI-style), and adjusted documentation table formatting to reflect standardized naming conventions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 The keys now dance in lowercase grace,
Snake_case sorted in their place,
Documentation neat and clean,
The finest docs we've ever seen! ✨

🚥 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 accurately describes the main changes: fixing config parameters, sorting them, and updating descriptions for the in_random plugin documentation.
Linked Issues check ✅ Passed The pull request addresses all objectives from linked issue #2342: standardizing parameter names to lowercase, sorting configuration parameters alphabetically, fixing inconsistent casing, and updating documentation formatting.
Out of Scope Changes check ✅ Passed All changes are scoped to the in_random plugin documentation file (pipeline/inputs/random.md) and directly address the stated objectives in issue #2342.
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.

@patrick-stephens patrick-stephens merged commit e201df1 into fluent:master Jan 22, 2026
8 checks passed
@eschabell eschabell deleted the erics_in_random_updates branch January 23, 2026 13:39
@eschabell eschabell added 5.0 and removed waiting-on-review Waiting on a review from mainteners 4.2.3 labels Jan 23, 2026
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.

in_random docs need updating

2 participants