about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMichael Howell <michael@notriddle.com>2022-06-11 21:47:03 -0700
committerMichael Howell <michael@notriddle.com>2022-06-11 21:47:03 -0700
commit36fb094d253d3364482570613635a467fab851cb (patch)
tree373a93699ad77e3746b37545215482b50241e7ad
parent22c39aa8355483796317dfa456b58e5a4be114ef (diff)
downloadrust-36fb094d253d3364482570613635a467fab851cb.tar.gz
rust-36fb094d253d3364482570613635a467fab851cb.zip
Add docs to `maybe_tuple_doc!`
-rw-r--r--library/core/src/tuple.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/library/core/src/tuple.rs b/library/core/src/tuple.rs
index d0d8c5faa44..ab3763cbc41 100644
--- a/library/core/src/tuple.rs
+++ b/library/core/src/tuple.rs
@@ -103,6 +103,8 @@ macro_rules! tuple_impls {
     }
 }
 
+// If this is a unary tuple, it adds a doc comment.
+// Otherwise, it hides the docs entirely.
 macro_rules! maybe_tuple_doc {
     ($a:ident @ #[$meta:meta] $item:item) => {
         #[cfg_attr(not(bootstrap), doc(tuple_variadic))]