docs: in_process: updates to config parameters#2330
Conversation
📝 WalkthroughWalkthroughUpdated the process input plugin documentation to rename configuration keys from CamelCase/mixedCase to lowercase_snake_case and reorder the table rows to match code expectations; values and descriptions remain effectively the same. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
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. Comment |
|
Requested review from one of the three of you @cosmo0920, @alexakreizinger, or @esmerel, first one wins! |
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pipeline/inputs/process.md (1)
56-63: FixInterval_NSeccasing in the classic config example.The PR objective calls out correcting this; the example still shows
Interval_NSec. If the convention isInterval_Nsec, update it here to match the rest of the docs and expected keys.🐛 Proposed fix
- Interval_NSec 0 + Interval_Nsec 0
🧹 Nitpick comments (1)
pipeline/inputs/process.md (1)
15-16: Consider tightening the wording in theinterval_nsecdescription.“In conjunction with” is a bit wordy for docs; a shorter phrasing reads better.
♻️ Suggested edit
-| `interval_nsec` | Specifies the interval between service checks, in nanoseconds. This works in conjunction with `interval_sec`. | `0` | +| `interval_nsec` | Specifies the interval between service checks, in nanoseconds. Used with `interval_sec`. | `0` |
- Sort configuration parameters table alphabetically - Change table parameter names to lowercase to match other input plugin docs Fixes fluent#2329 Signed-off-by: Eric D. Schabell <eric@schabell.org>
e3226fe to
4efae10
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pipeline/inputs/process.md (1)
59-63: FixInterval_NSeccasing in classic conf example.PR objective mentions correcting this, but the example still shows
Interval_NSec. If the convention isInterval_Nsec, update the example to avoid conflicting guidance.💡 Suggested change
- Interval_NSec 0 + Interval_Nsec 0
🧹 Nitpick comments (1)
pipeline/inputs/process.md (1)
15-16: Optional: tighten wording.“In conjunction with” could be shortened (e.g., “works with”) without losing meaning.
|
Thanks for the review @cosmo0920, merging! |
Fixes #2329
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.