chore: scrub internal issue/PR numbers from operator-facing text (#755)#756
Merged
Merged
Conversation
Internal GitHub #NNN references carry no meaning for an operator reading a warning, an error, the apply preview, or the dashboard — they read as noise. Remove them from user-facing product strings while keeping the explanatory prose intact. Comments and test labels keep their #NNN (developer-facing). - pithead: strip #NNN from log/warn/error/info/echo messages, the --help command descriptions, and describe_change's msg= apply-preview text (which the #33 control channel also renders in the dashboard config editor). Grammar preserved; load-bearing words kept (e.g. "removed in v1.9" stays, only the "#506," goes). Also dropped a stale "v1.6" reference while there. - dashboard: chart.mjs "Avg:" control tooltip. - Regression guard: scripts/lint-operator-strings.sh (wired into `make lint` and CI) fails if a #NNN reaches a pithead message or a dashboard frontend string; it exempts comments and CSS hex colours. Documented in CONTRIBUTING.md. Telegram, webhook, and ntfy message bodies were already clean (issue refs there live only in docstrings). No behaviour change. Stack suite 1622/0. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The guard's frontend scanner is non-trivial awk (comment-stripping + CSS hex-colour skip); a silent regression would make it stop catching leaks while still exiting 0. Extract the two scanners into functions and add a `--self-test` mode that drives fixtures through them — planted #NNN must be flagged, hex colours and comments must not. Wired into the stack suite (make test-stack/CI). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…crub-issue-numbers # Conflicts: # pithead
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
1 participant
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.
Closes #755.
Internal GitHub issue/PR numbers (
(#103),(#381),#168, …) were showing up in text an operator reads — warnings, errors, theapplypreview,--help, and one dashboard tooltip. They mean nothing to the reader and just add noise. This strips them from user-facing product strings while keeping the explanatory prose, and adds a lint guard so they don't creep back.What changed
pithead— removed#NNNfromlog/warn/error/info/echomessages, the--helpcommand descriptions, and thedescribe_changemsg=strings that show in the apply preview (and, via the Stack config editor: change any setting from the dashboard, applied via pithead (incl. P2Pool mode hot-swap) #33 control channel, the dashboard config editor). Grammar preserved; meaningful words kept — e.g."deprecated alias for workers.list[] (#506, removed in v1.9)"→"… (removed in v1.9)". Also dropped a stalev1.6reference in the Tari view-key error while there.chart.mjs— the "Avg:" chart-control tooltip no longer ends in(#168).scripts/lint-operator-strings.sh, wired intomake lintand CI, fails if a#NNNappears in apitheadoperator message or a dashboard frontend user-visible string. It exempts comments and test labels, and avoids false positives on CSS hex colours (#3fb950). Documented in CONTRIBUTING.md.Scope note
Telegram, webhook, and ntfy message bodies were already clean — issue refs there live only in docstrings, so nothing to do. Code comments and test-description labels keep their
#NNN(developer-facing, correct).Coordination with #754
PR #754 (remote Tari) deliberately followed the existing
(#NNN)convention in its new strings rather than half-converting the file ahead of this cleanup. Once both land, whichever merges second will need a trivial rebase pass — and the newlint-operator-stringscheck makes any missed straggler a hard CI failure rather than a silent regression.Testing
Stack suite 1622/0 (no test was coupled to a removed number), plus
make lint-sh lint-js lint-md lint-docs-voice lint-operator-stringsandtest-composegreen. No behaviour change — display text only.🤖 Generated with Claude Code