docs: verify the README example and finalize the 0.1.0 changelog - #10
Merged
Conversation
The rendered crate documentation comes from `docs/crate.md`, so the README shipped to crates.io without ever being compiled. Its example was written as a doctest -- `?` plus a trailing `Ok::<(), std::io::Error>(())` -- but nothing type-checked it, so it could drift from the API unnoticed. Include the README under `cfg(doctest)` so its example compiles and runs, and drop `no_run` so it actually executes. Replace the pre-publication installation note with `cargo add windows-spawn`, and state that this project is unaffiliated with Microsoft: the `windows-` prefix collides with the `windows-rs` crate family and describes the target platform, not the publisher. Fold the `Unreleased` section into `0.1.0`. That version was never tagged or published, so entries recorded as `Changed` and `Fixed` had no released baseline to differ from; they describe the behavior 0.1.0 ships. Record the reverse inheritance race and the deferred `sha2` bump as known limitations rather than leaving them only in the ADRs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Release preparation for the first
windows-spawnpublication.conpty-oxide0.1.2 depends on this crate through a path override and cannot be published
until
windows-spawn0.1.0 is on crates.io.What this changes
The README example was never compiled.
src/lib.rsrenders cratedocumentation from
docs/crate.md, so the README shipped to crates.io withoutpassing through rustdoc. Its example was written as a doctest (
?plus atrailing
Ok::<(), std::io::Error>(())) but nothing type-checked it. Includingthe README under
cfg(doctest)compiles and runs it without adding a secondfront page to the rendered docs.
no_runis dropped so it actually executes.Installation instructions. Replaced the pre-publication note with
cargo add windows-spawn, and stated that the project is unaffiliated withMicrosoft. The
windows-prefix collides with thewindows-rscrate familyand describes the target platform, not the publisher.
Changelog.
Unreleasedis folded into0.1.0. That version was nevertagged or published, so entries filed under
ChangedandFixedhad noreleased baseline to differ from. The reverse inheritance race and the deferred
sha2bump are recorded as known limitations instead of living only in ADRs.Verification
cargo test --doc --all-featuresreports 4 doctests, andsrc/lib.rs - readme_examplesisokrather thanignored, confirming theREADME example executes.
cargo public-apiis unchanged: this is docs only.🤖 Generated with Claude Code