rust-lang / rust-lang/rust-bindgen

Add a section to the users guide about deriving traits

Open
#1,106 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted I-needs-docs
Dominant language
Rust
Stars
5.3k
Forks
829
Avg merge
1d 1h
Merged PRs (30d)
15

Description

Should include info on:

  • How to enable non-default trait deriving

  • Heads up about situations in which we can't add derive(Trait) because, eg there is a floating point member in a struct so Eq can't be derived

  • Information about the --impl-blah options for when we can impl but can't derive

  • How to disable trait deriving/impling for specific types

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 in the users guide and review the requested topics: enabling non-default trait deriving, cases where deriving fails, --impl-blah options, and disabling deriving or impling for specific types. Done means the guide has a coherent section covering each listed item with appropriate examples or explanations.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/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.