Repository navigation
Add per-crate README for rsdm/adl2rsdm (release 0.5.4) - #4
Merged
Merged
Conversation
`rsplot` sets `readme = "README.md"` and its crates.io page renders it; `rsdm` and `adl2rsdm` had neither a `readme` field nor a README file, so their per-crate pages showed nothing (the rendered-readme endpoint 403s for 0.5.3). Each gets a README sourced from its own crate-level docs — rsdm's PyDM-port layout / feature-gated backends, adl2rsdm's adl2pydm-mirrored pipeline — plus the `readme = "README.md"` field, matching rsplot. Verified both land in the packaged `.crate`. crates.io bakes the README per published version, so this surfaces only on the next release, not retroactively on 0.5.3.
Documentation-only patch release: rsdm and adl2rsdm gained the README that crates.io renders per crate (they shipped without one; rsplot's already rendered). crates.io bakes the README into each published version, so surfacing it required a new release rather than an edit to 0.5.3. No code or behaviour changes. All three crates bump in lockstep as always.
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.
A documentation-only patch release. No code, API, or behaviour changes.
The bug
rsplotsetsreadme = "README.md"and its crates.io page renders it.rsdmand
adl2rsdmhad neither areadmefield nor a README file, so theirper-crate crates.io pages showed nothing — the rendered-readme endpoint 403s
for
rsdm/adl2rsdm0.5.3 whilersplot's returns 200.The fix
rsdm/README.mdandadl2rsdm/README.md, each sourced from that crate's owncrate-level docs (rsdm's PyDM-port layout and feature-gated backends;
adl2rsdm's adl2pydm-mirrored parse → symbols → codegen → convert pipeline).
readme = "README.md"in both manifests, matching rsplot..crate.crates.io bakes the README into each published version, so it surfaces only on
the next release, not retroactively on 0.5.3 — hence 0.5.4. All three crates
bump in lockstep (
rsplotre-released unchanged).Verification
cargo fmt --all --check,cargo clippy --workspace --all-targets -- -D warnings,cargo nextest run --workspace(2349/2349) andcargo test --doc --workspaceall pass locally.