Repository navigation
docs: state what regression tests guard, and fix a stale SDK comment - #453
Merged
Merged
Conversation
Comments only. Rewords the "used to" notes in locallibrary's tests and the web budget test as what the code does and why, drops two filler words from module docs, and lists all six of the plugin SDK's own features.
bnb
approved these changes
Nov 5, 2026
Coverage Report for apps/web
File CoverageNo changed files found.SizeCompared with main. KiB are 1,024 bytes.
|
Rust coverageFrom run 357. Both are held to the thresholds in .cargo/config.toml.
|
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.
What and why
A wording pass over the Rust and website comments. They were already plain: there isn't an em dash in any of them outside numeric ranges and quoted data, and "rather than" records a real choice nearly every time. So this is ten comments.
Six test comments in
crates/locallibrarytold what the code used to do. Each now says what the test guards and why, with the same reason in it:tests/it/convert.rs: a name too long for export.pdb, and why it's refused at planning.tests/it/drives.rs: why the player name goes back under the sync's lock.tests/it/edit/drifted_databases.rs: what happens to entries only OneLibrary has.tests/it/pack.rs: why an unreadable OneLibrary source is refused.tests/it/restore.rs: what undoing twice does.tests/it/watch.rs: dropped the "Regression:" label.apps/web/tests/build.test.tsdid the same in its note on the JavaScript budgets. It now says the build's total isn't capped, with the same reason.src/fscheck.rsandsrc/scrub.rseach lose a filler word ("actually", "simply").One comment was wrong. The doc on the SDK's
features()said its own features wereblobs,netandchoose. It keeps every row with no methods (sdk.rs), and six rows have none:accountsandanalysis(hooks) as well asblobs,net,chooseandviews(features.rs).Files other open branches are changing aren't touched. That includes most of
crates/locallibrary's tests.How it was tested
Every changed file compared with main with comments removed comes out identical.
cargo fmt --all --checkandcargo check -p loclib-plugin -p locallibrary --testspass, andoxfmt --checkandoxlintpass on the web test file.Checklist
docs/and--helpstill say what the code does (apps/locallibrary/docs/rpc/too, for a sidecar change)