Expand `derive` documentation.

Open
#540 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the Reference documentation for the derive attribute and compare its current coverage with the Rust Book's derivable traits appendix. Confirm the built-in derivable traits and decide whether to summarize their default-implementation semantics or link to existing core/std documentation. Done means the documentation clearly presents the supported list and the chosen semantics reference.

Written by the indexing model from the issue text.

Description

A-attributes

The derive attribute documentation should probably list the built-in traits that are derivable. To my knowledge, the list is:

  • Clone
  • Hash
  • PartialEq
  • Eq
  • PartialOrd
  • Ord
  • Debug
  • Default
  • Send
  • Sync
  • Copy

Should the documentation also specify the semantics of how the default implementations behave? It seems like important information, but I think it is mostly covered in the core/std docs. Another option is to link to https://doc.rust-lang.org/book/appendix-03-derivable-traits.html.

Dominant language
Rust
Stars
1.6k
Forks
607
Avg merge
1d 1h
Merged PRs (30d)
12

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.

More from rust-lang/reference

All issues in rust-lang/reference

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.