Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Jan 15, 2026

Fixes #2325.

Summary by CodeRabbit

  • Documentation
    • Reworked memory metrics table for improved formatting and alignment
    • Added a human-readable memory statistic entry and placed it before Swap entries
    • Updated ordering of rows for clearer reading
    • Minor wording and spacing refinements across memory metric descriptions (no changes to definitions or units)

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

@eschabell eschabell self-assigned this Jan 15, 2026
@eschabell eschabell requested review from a team as code owners January 15, 2026 17:57
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 15, 2026

📝 Walkthrough

Walkthrough

This pull request reformats and reorganizes the memory metrics table in pipeline/inputs/memory-metrics.md, inserting and repositioning the proc_hr row adjacent to proc_bytes and applying minor wording and spacing adjustments; no metric semantics or units were changed.

Changes

Cohort / File(s) Summary
Documentation Formatting
pipeline/inputs/memory-metrics.md
Reordered and reformatted the memory metrics table: adjusted header/alignment, moved proc_hr next to proc_bytes, updated row ordering (placing proc_hr before Swap.*), and applied minor wording/spacing tweaks to Mem.* and Swap.* rows.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

4.2.1

Suggested reviewers

  • alexakreizinger
  • cosmo0920

Poem

🐰
A hop through rows tidy and bright,
proc_hr joins proc_bytes just right,
Cells aligned, commas polite,
Docs whisper neat in the moonlight,
🥕✨

🚥 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 change—sorting the metrics table alphabetically in the memory-metrics documentation.
Linked Issues check ✅ Passed The PR addresses issue #2325 by reordering the metrics table alphabetically, directly fulfilling the stated objective of sorting tables in the Memory Metrics documentation.
Out of Scope Changes check ✅ Passed All changes are within scope—the PR only reformats and reorders the memory metrics table as specified in the linked issue, with no unrelated modifications.
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.



📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1e33a2d and 5964f06.

📒 Files selected for processing (1)
  • pipeline/inputs/memory-metrics.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • pipeline/inputs/memory-metrics.md

✏️ Tip: You can disable this entire section by setting review_details to false in your review 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 force-pushed the erics_in_memory_metrics_updates branch from 1e33a2d to 5964f06 Compare January 15, 2026 18:01
@eschabell
Copy link
Collaborator Author

@alexakreizinger trivial changes.

@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

4.2.3 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Input plugin Memory Metrics general cleanup for docs

2 participants