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

rustdoc search command #2207

Closed
brson opened this Issue Apr 14, 2012 · 11 comments

Comments

Projects
None yet
9 participants
@brson
Contributor

brson commented Apr 14, 2012

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

This comment has been minimized.

Show comment
Hide comment
@graydon

graydon Apr 16, 2012

Contributor

yes!

Contributor

graydon commented Apr 16, 2012

yes!

@dbp

This comment has been minimized.

Show comment
Hide comment
@dbp

dbp Oct 9, 2012

Contributor

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.

Contributor

dbp commented Oct 9, 2012

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

This comment has been minimized.

Show comment
Hide comment
@alexcrichton

alexcrichton May 2, 2013

Member

Nominating for feature-complete

Member

alexcrichton commented May 2, 2013

Nominating for feature-complete

@graydon

This comment has been minimized.

Show comment
Hide comment
@graydon

graydon May 30, 2013

Contributor

accepted for feature-complete milestone

Contributor

graydon commented May 30, 2013

accepted for feature-complete milestone

@catamorphism

This comment has been minimized.

Show comment
Hide comment
@catamorphism

catamorphism Jul 22, 2013

Contributor

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

Contributor

catamorphism commented Jul 22, 2013

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

@cmr

This comment has been minimized.

Show comment
Hide comment
@cmr

cmr Aug 15, 2013

Member

#8125

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

Member

cmr commented Aug 15, 2013

#8125

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

@dobkeratops

This comment has been minimized.

Show comment
Hide comment
@dobkeratops

dobkeratops Sep 23, 2013

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

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

This comment has been minimized.

Show comment
Hide comment
@catamorphism

catamorphism Oct 24, 2013

Contributor

Low, not 1.0

Contributor

catamorphism commented Oct 24, 2013

Low, not 1.0

@huonw

This comment has been minimized.

Show comment
Hide comment
@huonw

huonw Jan 29, 2014

Member

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.

Member

huonw commented Jan 29, 2014

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.

@cmr

This comment has been minimized.

Show comment
Hide comment
@cmr

cmr Jul 28, 2014

Member

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

Member

cmr commented Jul 28, 2014

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

@steveklabnik

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik Jan 21, 2015

Member

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

Member

steveklabnik commented Jan 21, 2015

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment