Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rust docs: Please add groupings of producers and consumers by type #37061

Open
dagit opened this issue Oct 9, 2016 · 2 comments
Open

Rust docs: Please add groupings of producers and consumers by type #37061

dagit opened this issue Oct 9, 2016 · 2 comments
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@dagit
Copy link

dagit commented Oct 9, 2016

I find myself often navigating to rustdocs and then clicking through to the [src] link instead of using the docs directly (or bypassing rustdoc and going to the git repo). The most common reason I find myself doing this is because I'm trying to learn the interface for some type that I want to use.

Coming from an algebraic datatype background, I often want to know the set of ways to introduce a type and the different functions that accept that type (roughly speaking, producers and consumers of a type).

The rustdocs as they are today do a good job of listing the impl functions for a type and enumerating traits for the type. So what more do I want? Let's say there is a module foo that defines the type Foo. Often times foo, and other modules within the same library, also define functions that operate on Foo. I would like a convenient way to see these functions together. Perhaps we could call it a type indexed index :)

I apologize if this feature already exists and I've overlooked it.

Thanks in advance!

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 9, 2016
@steveklabnik steveklabnik added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Dec 22, 2016
@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@steveklabnik
Copy link
Member

Triage: no changes. @rust-lang/rustdoc , is this a feature that will ever be implemented?

@ehuss ehuss removed the T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. label Jan 18, 2022
@cmpute
Copy link

cmpute commented Dec 11, 2022

FWIW, currently you can search for all functions that takes a type as parameter directly in the search bar. Maybe this solves the problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

4 participants