rustdoc search command

[brson]

I want to be able to write rustdoc search vec::each and have rustdoc tell me the docs. It would use the following algorithm:

• Locate all the source crates (.rc files) under the current path
• Locate all the compiled crates used by those source crates
• Scan the all the found source and compiled crates for matching items/methods/variants, etc
• Generate the docs for all the matches
• Maybe provide interactive selection when there are multiple matches

Requires #2206

[graydon]

yes!

[dbp]

I'm sort of working on this (not pulling out of metadata, but rather out of what rustdoc generates, for now), and more (searching by types), over here: http://github.com/dbp/rustle . Perhaps it would make sense to integrate it into rustdoc once it has stabilized a little.

[alexcrichton]

Nominating for feature-complete

[graydon]

accepted for feature-complete milestone

[catamorphism]

Bug triage: still a bug, milestone/tags look good.

[emberian]

#8125

Such a tool could be implemented by caching rustdoc_ng's JSON in the rustpkg workspace. Perhaps in $workspace/docs/json. @catamorphism?

[dobkeratops]

on a related note, how about adding tag-cloud search ... some sort of annotation in docstrings for tagging documented entities for non-heirachical search. for example , functions could be tagged with the names of similar functions in other languages
http://en.wikipedia.org/wiki/Tag_cloud

[catamorphism]

Low, not 1.0

[huonw]

We now have online/HTML search via some JS included with rustdoc, but nothing at the command line, and it's only within a single crate.

[emberian]

The search is now within multiple crates. Original reasoning about rustpkg still applies to cargo.

[steveklabnik]

I'm pulling a massive triage effort to get us ready for 1.0. As part of this, I'm moving stuff that's wishlist-like to the RFCs repo, as that's where major new things should get discussed/prioritized.

This issue has been moved to the RFCs repo: rust-lang/rfcs#647