rust-lang / rust-lang/rustup

`rustup doc` should support searching for names

Open
#4,165 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
22h 40m
Merged PRs (30d)
46

Description

Problem you are trying to solve

rustup doc requires giving the exact path to an item in order to get its documentation. I'd love to write rustup doc File rather than rustup doc std::fs::File.

Solution you'd like

rustup doc File should open the documentation for std::fs::File.

This could work by doing the search in rustup, or by opening the rustdoc search page with a query of File.

Notes

No response

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 does not name files or tests. Start by locating the rustup doc command entry point and tracing how its argument is handled. Done means a name such as File opens the corresponding documentation, while existing exact-path usage continues to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
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.