rust-lang / rust-lang/rust-bindgen

Emit #[doc(alias)] for renamed items

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

Nobody has claimed this yet.

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

Description

The Rust 1.48 announcement suggests the use of the new #[doc(alias)] for FFI crates. This seems like a reasonable thing for bindgen to do if an item gets renamed.

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

The issue names no files, tests, or entry points. Start by locating bindgen's item-renaming and Rust attribute-generation paths, then inspect existing tests for renamed items; done means renamed items consistently receive the corresponding #[doc(alias)] metadata.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.