rust-lang / rust-lang/reference

Document auto-generated drop glue

Open
#873 18 comments 2 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

There should be a section in the reference which document how the compiler-generated drop glue behaves. It should answer questions like this one: https://github.com/rust-lang/unsafe-code-guidelines/issues/225.

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

Start by reading the Rust Reference's existing reference material and the linked unsafe-code-guidelines issue 225 to identify the questions the new section should answer. Document how compiler-generated drop glue behaves, with the work complete when the Reference contains a clear, self-contained explanation of that behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.