rust-lang / rust-lang/reference

Describe layout in terms of memory, not types

Open
#943 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

While the type system has considerable control over the layout of memory, the layout is fundamentally a concern of memory. It should be under the memory model chapter and describe memory.

We can say that types also have the properties defined by layout if for all values of that type, they share the same value for that property of the layout.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the layout section and the memory model chapter in the Rust Reference, then compare how layout is currently described in terms of types and memory. Reorganize or revise the documentation so layout is presented as a property of memory, while noting when types share layout properties; done means the chapter placement and terminology reflect that distinction.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.