about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2023-06-22 14:06:15 -0700
committerJosh Triplett <josh@joshtriplett.org>2023-06-22 14:06:43 -0700
commitf972e09f76e5d5557a56026b4ffa78eb76df6564 (patch)
treea341ec8f8a036365639a28734307d3df3a053e83
parent5d637219e43ed61f05f0c4e9c48f9b692a8c1147 (diff)
downloadrust-f972e09f76e5d5557a56026b4ffa78eb76df6564.tar.gz
rust-f972e09f76e5d5557a56026b4ffa78eb76df6564.zip
style-guide: Define what an item is
-rw-r--r--src/doc/style-guide/src/items.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/doc/style-guide/src/items.md b/src/doc/style-guide/src/items.md
index 8a0954f5343..1e0e60248bf 100644
--- a/src/doc/style-guide/src/items.md
+++ b/src/doc/style-guide/src/items.md
@@ -1,5 +1,10 @@
 ## Items
 
+Items consist of the set of things permitted at the top level of a module.
+However, Rust also allows some items to appear within some other types of
+items, such as within a function. The same formatting conventions apply whether
+an item appears at module level or within another item.
+
 `extern crate` statements must be first in a file. They must be ordered
 alphabetically.