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

Rustdoc search: Increase relevance of primitive types #25702

Merged
merged 3 commits into from
May 23, 2015

Conversation

killercup
Copy link
Member

This minimally changes rustdoc's search as described in #25167.

Additionally, I also cleaned up some parts of the JS code.

There is one more change I made: After each result for a primitive type, I added "(Overview of primitive type)". This further differentiates the result from the module (previously, the only difference was that the module's link was blue). I'm not this is the way to go (this seems to be the only place where we do this) and it's no problem for me to remove that commit.

std__str_-_rust

cc @steveklabnik (it concerns docs) and @alexcrichton (who made changes to rustdoc previously)

killercup added 2 commits May 22, 2015 14:14
There are more possible optimizations left (cached length in loops) as
well as some possible bugs (shadowed variables) to fix. This is mostly
syntactic.
@rust-highfive
Copy link
Collaborator

r? @pcwalton

(rust_highfive has picked a reviewer for you, use r? to override)

@bluss
Copy link
Member

bluss commented May 22, 2015

This is a great idea. What do you think about just a simpler phrase like (primitive type) for the highlight?

@killercup
Copy link
Member Author

@bluss, I like that. Italic, too?

@Gankra Gankra assigned Gankra and unassigned pcwalton May 22, 2015
@Gankra
Copy link
Contributor

Gankra commented May 22, 2015

r=me with the (primitive type) hint updated as discussed.

@killercup killercup force-pushed the rustdoc/search-primitives branch from 1253c13 to 07b1994 Compare May 22, 2015 20:15
@killercup
Copy link
Member Author

@gankro thanks for the review. This is how it looks now:

std_-_rust

@Gankra
Copy link
Contributor

Gankra commented May 22, 2015

@bors r+ rollup

Awesome, thanks!

@bors
Copy link
Contributor

bors commented May 22, 2015

📌 Commit 07b1994 has been approved by Gankro

@killercup killercup force-pushed the rustdoc/search-primitives branch from 07b1994 to ec60d9f Compare May 22, 2015 20:18
@killercup
Copy link
Member Author

@gankro I think bors picked the commit I just replaced. (Doesn't matter though, I only changed the commit message.)

@Gankra
Copy link
Contributor

Gankra commented May 22, 2015

@bors r-

@Gankra
Copy link
Contributor

Gankra commented May 22, 2015

@bors r+ ec60d

@Gankra
Copy link
Contributor

Gankra commented May 22, 2015

(we'll see if that worked... the PR is certainly still approved in the queue...)

@killercup
Copy link
Member Author

Thanks! :)

@steveklabnik
Copy link
Member

@gankro @bors doesn't leave the message when you specify a commit hash, so i think this should be fine

@bluss
Copy link
Member

bluss commented May 22, 2015

Lol I didn't intend the italic. Either works.

@Gankra
Copy link
Contributor

Gankra commented May 22, 2015

I liked the italic, and it's trivial to fiddle with later.

oli-obk pushed a commit to oli-obk/rust that referenced this pull request May 23, 2015
…, r=Gankro

This minimally changes rustdoc's search as described in rust-lang#25167.

Additionally, I also cleaned up some parts of the JS code.

There is one more change I made: After each result for a primitive type, I added "(Overview of primitive type)". This further differentiates the result from the module (previously, the only difference was that the module's link was blue). I'm not this is the way to go (this seems to be the only place where we do this) and it's no problem for me to remove that commit.

![std__str_-_rust](https://cloud.githubusercontent.com/assets/20063/7770589/67e8cb26-0090-11e5-8f99-c2a3af9fa37f.png)

cc @steveklabnik (it concerns docs) and @alexcrichton (who made changes to rustdoc previously)
oli-obk pushed a commit to oli-obk/rust that referenced this pull request May 23, 2015
…, r=Gankro

This minimally changes rustdoc's search as described in rust-lang#25167.

Additionally, I also cleaned up some parts of the JS code.

There is one more change I made: After each result for a primitive type, I added "(Overview of primitive type)". This further differentiates the result from the module (previously, the only difference was that the module's link was blue). I'm not this is the way to go (this seems to be the only place where we do this) and it's no problem for me to remove that commit.

![std__str_-_rust](https://cloud.githubusercontent.com/assets/20063/7770589/67e8cb26-0090-11e5-8f99-c2a3af9fa37f.png)

cc @steveklabnik (it concerns docs) and @alexcrichton (who made changes to rustdoc previously)
oli-obk pushed a commit to oli-obk/rust that referenced this pull request May 23, 2015
…, r=Gankro

This minimally changes rustdoc's search as described in rust-lang#25167.

Additionally, I also cleaned up some parts of the JS code.

There is one more change I made: After each result for a primitive type, I added "(Overview of primitive type)". This further differentiates the result from the module (previously, the only difference was that the module's link was blue). I'm not this is the way to go (this seems to be the only place where we do this) and it's no problem for me to remove that commit.

![std__str_-_rust](https://cloud.githubusercontent.com/assets/20063/7770589/67e8cb26-0090-11e5-8f99-c2a3af9fa37f.png)

cc @steveklabnik (it concerns docs) and @alexcrichton (who made changes to rustdoc previously)
oli-obk pushed a commit to oli-obk/rust that referenced this pull request May 23, 2015
…, r=Gankro

This minimally changes rustdoc's search as described in rust-lang#25167.

Additionally, I also cleaned up some parts of the JS code.

There is one more change I made: After each result for a primitive type, I added "(Overview of primitive type)". This further differentiates the result from the module (previously, the only difference was that the module's link was blue). I'm not this is the way to go (this seems to be the only place where we do this) and it's no problem for me to remove that commit.

![std__str_-_rust](https://cloud.githubusercontent.com/assets/20063/7770589/67e8cb26-0090-11e5-8f99-c2a3af9fa37f.png)

cc @steveklabnik (it concerns docs) and @alexcrichton (who made changes to rustdoc previously)
bors added a commit that referenced this pull request May 23, 2015
@bors bors merged commit ec60d9f into rust-lang:master May 23, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants