rust-lang / rust-lang/rust

"single tab mode" for rustdoc search

Open
#132,110 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement T-rustdoc T-rustdoc-frontend
Dominant language
Rust
Stars
119k
Forks
16.2k
PR merge metrics
PR metrics pending

Description

currently, when performing a single-element search (i.e. a name-based search), there are 3 tabs:

  1. In Names
  2. In Parameters
  3. In Return Types

I basically never use the other two, instead explicitly using type-based search with -> if i want that info.

These extra tabs add visual clutter and also slow down the searching process.

I propose an option in the settings panel to disable these extra tabs.

related: https://github.com/rust-lang/rust/issues/131156

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 reading the rustdoc search implementation and the settings panel, then review related issue #131156 for existing context. Determine how a setting could hide the Parameters and Return Types tabs for single-element searches, and verify that name-based and type-based searches retain their intended behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.