Skip to content

docs: state what regression tests guard, and fix a stale SDK comment - #453

Merged
botandbang merged 1 commit into
mainfrom
bnb/humanize-rust-core
Nov 5, 2026
Merged

botandbang merged 1 commit into
mainfrom
bnb/humanize-rust-core

Conversation

@botandbang

Copy link
Copy Markdown
Contributor

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/locallibrary told 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.ts did 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.rs and src/scrub.rs each lose a filler word ("actually", "simply").

One comment was wrong. The doc on the SDK's features() said its own features were blobs, net and choose. It keeps every row with no methods (sdk.rs), and six rows have none: accounts and analysis (hooks) as well as blobs, net, choose and views (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 --check and cargo check -p loclib-plugin -p locallibrary --tests pass, and oxfmt --check and oxlint pass on the web test file.

Checklist

  • The READMEs, docs/ and --help still say what the code does (apps/locallibrary/docs/rpc/ too, for a sidecar change)

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.
@botandbang
botandbang requested a review from bnb as a code owner November 5, 2026 15:16
@github-actions github-actions Bot added web The Local Network website (apps/web) locallibrary locallibrary and the loclib-* crates locallibrary: core The core crate, the data model and rekordbox's formats locallibrary: plugins The plugin protocol, its host and the built-in plugins tests Tests, fixtures and test harnesses labels Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Coverage Report for apps/web

Status Category Percentage Covered / Total
🟢 Lines 98.16% (🎯 98%)
🟰 ±0 pp
10227 / 10418
🟢 Statements 97.15% (🎯 97%)
🟰 ±0 pp
15515 / 15969
🟢 Functions 96.64% (🎯 96%)
🟰 ±0 pp
4116 / 4259
🟢 Branches 91.93% (🎯 91%)
🟰 ±0 pp
7510 / 8169
File CoverageNo changed files found.
Generated in workflow #357 for commit 40e3972 by the Vitest Coverage Report Action

Size

Compared with main. KiB are 1,024 bytes.

This pull request main Change
Client JavaScript 771.3 KiB 771.3 KiB 0 B (0%)
Client JavaScript, brotli 259.3 KiB 259.3 KiB 0 B (0%)
Client CSS 94.5 KiB 94.5 KiB 0 B (0%)
Client CSS, brotli 13.6 KiB 13.6 KiB 0 B (0%)

@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Rust coverage

From run 357. Both are held to the thresholds in .cargo/config.toml.

Tests Lines Functions Regions
All 97.65% (87902/90016) 97.05% (14296/14731) 96.04% (194286/202294)
Hegel property tests alone 96.09% (86497/90016) 95.4% (14053/14731) 94.36% (190883/202294)

@botandbang
botandbang added this pull request to the merge queue Nov 5, 2026
Merged via the queue into main with commit 1d0af97 Nov 5, 2026
68 of 70 checks passed
@botandbang
botandbang deleted the bnb/humanize-rust-core branch November 5, 2026 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

locallibrary: core The core crate, the data model and rekordbox's formats locallibrary: plugins The plugin protocol, its host and the built-in plugins locallibrary locallibrary and the loclib-* crates tests Tests, fixtures and test harnesses web The Local Network website (apps/web)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants