Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document slice DSTs and size validity at the crate root #1263

Closed
Tracked by #29
joshlf opened this issue May 14, 2024 · 0 comments · Fixed by #1273
Closed
Tracked by #29

Document slice DSTs and size validity at the crate root #1263

joshlf opened this issue May 14, 2024 · 0 comments · Fixed by #1273

Comments

@joshlf
Copy link
Member

joshlf commented May 14, 2024

Add a section to our crate root docs roughly with the following shape:

//! # Dynamically-sized types
//! 
//! Zerocopy supports slice-based dynamically sized types ("slice DSTs", or just
//! "DSTs" for short) via the [`KnownLayout`] trait.
//! 
//! A slice DST is a type...
//! 
//! ## What is a valid size?
//! 
//! ...

The section should give an overview of slice DSTs at a level of detail appropriate for our users. The "What is a valid size?" sub-section should describe the concept of "has a valid size for T", which is used in places in our API where we support slice DSTs. Those places should link to this sub-section.

joshlf added a commit that referenced this issue May 16, 2024
joshlf added a commit that referenced this issue May 16, 2024
joshlf added a commit that referenced this issue May 17, 2024
joshlf added a commit that referenced this issue May 17, 2024
github-merge-queue bot pushed a commit that referenced this issue May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant