about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorCamelid <camelidcamel@gmail.com>2020-09-09 18:38:42 -0700
committerJoshua Nelson <joshua@yottadb.com>2020-09-09 22:58:18 -0400
commit390716c873b29322570e24355354f2feb734462a (patch)
treeca248ffb9dde0b09abe4172aceadec70127da865 /src/doc/rustc-dev-guide
parent8ad13b0c88b2b030d2baab60908f6c2f1676f849 (diff)
downloadrust-390716c873b29322570e24355354f2feb734462a.tar.gz
rust-390716c873b29322570e24355354f2feb734462a.zip
Add more info about Rustdoc
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/contributing.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/contributing.md b/src/doc/rustc-dev-guide/src/contributing.md
index c79dd3e3ff2..98b1a2d7ffb 100644
--- a/src/doc/rustc-dev-guide/src/contributing.md
+++ b/src/doc/rustc-dev-guide/src/contributing.md
@@ -490,7 +490,10 @@ are:
 * The [Rust Compiler Testing Docs][rctd]
 * For [@bors], [this cheat sheet][cheatsheet] is helpful
 * **Google!** is always helpful when programming :)
-* [Search Rust documentation][stddocs] to find types, traits, etc. quickly
+* [Search Rust documentation][stddocs] to find types, traits, etc. quickly.
+  You can also search by type signature! For example, searching for
+  `* -> vec` should find all functions that return a `Vec<T>`. _Hint:_ Find
+  more tips and keyboard shortcuts by typing `?` on any Rustdoc page!
 * Don't be afraid to ask! The Rust community is friendly and helpful.
 
 [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/about-this-guide.html