rust-lang / rust-lang/rust

rustdoc: allow searching for function kinds/modifiers, e.g. `const` or `unsafe`

Open
#162,491 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently it's not possible to search for all unsafe functions in a crate, it would be nice to be able to do so.

I think the only modifiers to support are const, async, extern and unsafe ?

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 locating rustdoc's search implementation and the existing function search behavior. Determine how searches could distinguish const, async, extern, and unsafe functions, then verify that each supported modifier returns the expected functions without changing unrelated search results.

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
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.