Add docs to combine macro

tcharding · Jan 10, 2024 · 8f6e9df · 8f6e9df
1 parent 8efc290
commit 8f6e9df
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/macros.rs b/src/macros.rs
@@ -1,5 +1,9 @@
 // SPDX-License-Identifier: CC0-1.0
 
+/// Combines the given `$thing` field of two types by setting `self.thing` to be
+/// the value in `other.thing` iff `self.thing` is currently empty.
+///
+/// If `self.thing` already contains a value then this macro does nothing.
 #[allow(unused_macros)]
 macro_rules! combine {
     ($thing:ident, $slf:ident, $other:ident) => {