Repository navigation
docs: correct what a review found drifting, and record D74 - #168
Merged
Merged
Conversation
A docs-drift review (every name, number, link and decision reference in the docs against the code, the CI and crates.io) found statements that were no longer true: - CONTRIBUTING said THIRD_PARTY_NOTICES.md ships wherever LICENSE does; the crates on crates.io carry LICENSE alone (the notices ship in the release archives, D51). Whether the crates should carry them is left to the maintainer. - The README and the 1.0 checklist said 26 wgpu-typed public items; the scan gives 25 plus the re-export, and D70 said about thirty: now "about thirty". - ARCHITECTURE's memory table gave the packed planes as 11.9 MiB at 4K; with the decoder's padding they are 12.1 MiB, the player's saving 43.8 MiB. - The README and BENCHMARKS said emberwave and HEVC take about as long on the Mac at 60 frames a second, from the 0.11.0 runs; they now say what the 0.18.1 runs beside a display loop found. - BENCHMARKS' claims that everything outside the results is hand-written, that the CPU encoder takes a quarter of a second (it takes a fifth), that #86 is open, the chroma exceptions, and the iOS README's three minutes; the FFI README's "not run on an iPhone". - Cargo.toml and D5 still said the crates are not published: D74 records the publication of emberwave-core and emberwave-cli. Claude-Session: https://claude.ai/code/session_019fJGoCTvP5e7n599q3ZQ42
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.
Purpose
A docs-drift review read every name, number, link and decision reference in the docs against the code, the CI and crates.io. This corrects what it found that was wrong or misleading, docs only, and records the crates.io publication as D74.
Changes
LICENSEdoes": the crates on crates.io carryLICENSEalone.TexturePicture); issue v1.0 decisions: versioned library name and how wgpu shows in the Rust API #165 corrected the same way.For the maintainer
D74's "Not done":
THIRD_PARTY_NOTICES.mdis not in the packages on crates.io (cargo package --listshowsLICENSEand no notices file), where the release archives carry both. Whether a crate has to carry PyroWave's notice is a licensing judgement that is not made here.Testing
Docs, a comment in
Cargo.tomland two comments inscripts/bench.shonly:cargo metadata --lockedstill works, no code changes. The reviewer's other findings are small and were checked against the code before the sentences changed.