Fix metrics doc drift and counters.sh shell prologue#892
Merged
Conversation
Two review findings on the runtime-metrics content: - ARCHITECTURE.md described the progress model as byte-weighted, summed once up front and credited at file completion - the pre-operation-weighted behavior. The current model (operation-weighted, total grows as heavy operations are discovered, credited per operation) is what README, HISTORY, and Metrics.cs implement, so align the architecture prose to it. - Docker/counters.sh used set -euo pipefail; committed shell scripts use the full set -Eeuo pipefail per the Workflow YAML Conventions shell rule. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates PlexCleaner’s documentation and Docker helper script to match the current runtime-metrics behavior and the repository’s bash prologue convention, so the next develop -> main promotion carries the corrected prose and script semantics.
Changes:
- Fix
ARCHITECTURE.mdruntime-metrics prose to describe the operation-weightedprogress.ratiomodel (not the older byte-weighted/up-front-summed model). - Update
Docker/counters.shto useset -Eeuo pipefail(enablingERRtrap inheritance via-E).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Docker/counters.sh | Switch bash prologue to set -Eeuo pipefail while keeping bash shebang and behavior intact. |
| ARCHITECTURE.md | Correct runtime-metrics documentation to align with the operation-weighted progress model described elsewhere. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two review findings surfaced on the open
develop -> mainpromotion (#884), both real and both on runtime-metrics content already merged todevelop. Fixing them ondevelopso the promotion carries the fix rather than the defect.1. ARCHITECTURE.md described the pre-operation-weighted model
The Runtime Metrics subsection still said progress is "byte-weighted" and "weighted by input bytes (summed once up front and credited at completion)" - the behavior before #869. The current model is operation-weighted: each heavy full-file operation counts the file's size as work when it starts and when it finishes, and the total grows as operations are discovered rather than being summed up front. That is what README, HISTORY, and
Metrics.csdescribe; ARCHITECTURE.md was the one place the old prose survived the #869 sweep. Both theprogress.ratiolabel and the weighting bullet are corrected.2. Docker/counters.sh used the short shell prologue
set -euo pipefail->set -Eeuo pipefail, per the Workflow YAML Conventions shell rule (committed.shscripts start with the full-Eeuoso a laterERRtrap inherits).Verification
markdownlint-cli2, editorconfig-checker, shellcheck (counters.sh), cspell (README/HISTORY), husky pre-commit gate all clean. ARCHITECTURE.md CRLF, counters.sh LF preserved. No
byte-weighted/summed once up frontprose remains anywhere. No C# changed.