rust-lang / rust-lang/rustup

rustup completions inline help is less clear than current markdown

Open
#1,952 0 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

Describe the problem you are trying to solve

Improve inline description for rustup completions, especially for Windows-centric users, that are likely less familiar with "completions", without the specific context of console/terminal tab-completion

Describe the solution you'd like

I suggest we update the inline help (src/cli/rustup_mode.rs:L514) to more closely (if not exactly) match the text currently included in the rustup markdown

Notes

I intend to submit a pull request for this.

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 at src/cli/rustup_mode.rs:L514 and compare its inline completion help with the rustup markdown section for enabling tab completion for Bash, Fish, Zsh, or PowerShell. Update the inline wording to provide that context for Windows-centric users, then verify the resulting rustup completion help output.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.