rust-lang / rust-lang/rust

rustdoc search: allow type-based search for constants and statics

Open
#129,708 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-rustdoc-search C-feature-request T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Currently it is possible to search for function items based on their signature, but it is not possible to search for other kinds of items based on their type.

@rustbot label A-rustdoc-search

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 existing function-item signature search and how it represents searchable item types. Extend the search behavior to cover constants and statics by their types, then verify that type-based queries return those items alongside functions.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.