mozilla / mozilla/cbindgen

Allow for more granular documentation parsing

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

Nobody has claimed this yet.

Dominant language
Rust
Stars
3k
Forks
386
Avg merge
1h 43m
Merged PRs (30d)
1

Description

Apologies if this issue has already been raised! I did not see it when searching but I might have just not searched hard enough :)

Right now, including documentation when parsing is a simple bool that applies for the crate I am generating for as well as any dependencies I might be including. However, I might want to have short documentation for dependencies, or no documentation for dependencies, or a mix and match where I want documentation for some dependencies but not others. If it was possible to define documentation parsing on a per-dependency basis, that would be much appreciated!

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 locating the configuration and dependency-parsing paths that currently use the single documentation boolean. Define how documentation settings should apply to the generated crate and to each dependency, then verify that users can select short, absent, or included documentation independently for dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.