rust-lang / rust-lang/rust

rustdoc should say if a feature is available by default

Open
#130,638 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-rustdoc-ui C-enhancement F-doc_cfg T-rustdoc T-rustdoc-frontend
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

when it has a snippet like this under an item:

Available on crate features fmt and std only.

there should be an additional (enabled by default) note if they're enabled by default.

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 tracing rustdoc's generation of the “Available on crate features” note for items. Verify how default-enabled features are represented, then confirm the generated documentation distinguishes features available by default from features that require explicit enabling.

Written by the indexing model from the issue text.

Assessment

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