docs: finalize the 0.1.0 documentation - #18
Merged
Conversation
Why: first-time users need to choose a direction and understand which Serde metadata is reflected before they can evaluate the graph model. State that contract explicitly and keep serde_shape overrides separate from Serde runtime behavior.
Why: the published API mixed imperative summaries with type descriptions and left the proc-macro crate without useful landing-page guidance. Use consistent noun phrases and third-person method summaries, and make the derive boundary visible on docs.rs.
Why: 0.1.0 is the first public release of the current design, so an internal chronology of unreleased rewrites does not help users. Remove it and stop directing contributors to maintain release notes that have no published baseline.
Why: the README tables should remain readable in source form as well as rendered output. Pad every table to consistent column widths, following the documentation style used by datasketches-rust.
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.
Summary
serde_shapeextensions clearly separateddatasketches-rust, including useful landing documentation for the derive crateThis PR changes documentation only. It does not change public APIs or reflection behavior.
Review order
afd1d43 docs: explain the reflection contract before the API071c9cb docs: align rustdoc with the public documentation stylea6de9f9 docs: remove the pre-release changelog4413b1b docs: align Markdown table columnsDocumented design boundary
Serde attributes remain the source of truth for serialization behavior. The
serde_shapenamespace only fills reflection-specific gaps:serialize_withdeserialize_withboundIt does not provide competing rename, tag, skip, flatten, alias, or default behavior.
Validation
cargo x lintcargo x build --lockedcargo x testcargo x package --lockedcargo +1.85.0 x testcargo +1.85.0 check -p serde-shape --lib --no-default-features --target thumbv7em-none-eabihfcargo +1.85.0 check -p serde-shape-test-no-std --lib --target thumbv7em-none-eabihf