rust-lang / rust-lang/rust

rustdoc type-based seach: allow search by lifetime parameters

Open
#129,160 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

many libraries give lifetimes meaningful names, such as the object crate

being able to navigate these libraries by typing lifetimes like 'data into the search bar would be quite helpful. additionally, searching for '_ should show all types that have a lifetime parameter (useful for finding reference-like types).

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 type-based search implementation from the search bar and existing lifetime handling. Define the behavior for named lifetimes such as 'data and the wildcard '; done means both queries return the appropriate types, including all types with lifetime parameters for '.

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.