about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMuhammad Falak R Wani <falakreyaz@gmail.com>2022-02-06 11:23:02 +0530
committerMuhammad Falak R Wani <falakreyaz@gmail.com>2022-02-06 11:23:02 +0530
commit6706ab8cfbe2bd3d093b5f995f5e59e42a1285c2 (patch)
tree617771c7fba6c7355cf45593fd02b46bc3738b18
parent88fb06a1f331926bccb448acdb52966fd1ec8a92 (diff)
downloadrust-6706ab8cfbe2bd3d093b5f995f5e59e42a1285c2.tar.gz
rust-6706ab8cfbe2bd3d093b5f995f5e59e42a1285c2.zip
keyword_docs: document use of `in` with `pub` keyword
Signed-off-by: Muhammad Falak R Wani <falakreyaz@gmail.com>
-rw-r--r--library/std/src/keyword_docs.rs14
1 files changed, 14 insertions, 0 deletions
diff --git a/library/std/src/keyword_docs.rs b/library/std/src/keyword_docs.rs
index 35d230eee96..8733e5190ee 100644
--- a/library/std/src/keyword_docs.rs
+++ b/library/std/src/keyword_docs.rs
@@ -728,6 +728,20 @@ mod impl_keyword {}
 /// [`IntoIterator`]: ../book/ch13-04-performance.html
 /// [range patterns]: ../reference/patterns.html?highlight=range#range-patterns
 /// [`for`]: keyword.for.html
+///
+/// The other use of `in` is with the keyword `pub`. It allows users to declare an item as visible
+/// only within a given scope.
+///
+/// ## Literal Example:
+///
+///    * `pub(in crate::outer_mod) fn outer_mod_visible_fn() {}` - fn is visible in `outer_mod`
+///
+/// Starting with the 2018 edition, paths for `pub(in path)` must start with `crate`, `self` or
+/// `super`. The 2015 edition may also use paths starting with `::` or modules from the crate root.
+///
+/// For more information, see the [Reference].
+///
+/// [Reference]: ../reference/visibility-and-privacy.html#pubin-path-pubcrate-pubsuper-and-pubself
 mod in_keyword {}
 
 #[doc(keyword = "let")]