From 16171c03ef3e3f528de71bea7bd56a0ca8a8c013 Mon Sep 17 00:00:00 2001
From: Danny Robson <danny@nerdcruft.net>
Date: Tue, 13 Jun 2017 17:00:17 +1000
Subject: [PATCH] tuple: better document the 'ignore' function

---
 tuple.hpp | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/tuple.hpp b/tuple.hpp
index 60c98881..b347e23b 100644
--- a/tuple.hpp
+++ b/tuple.hpp
@@ -166,10 +166,14 @@ namespace util::tuple {
 
 
     ///////////////////////////////////////////////////////////////////////////
-    // do nothing with a set of parameters.
-    //
-    // useful for temporarily silencing unused argument warnings in parameter
-    // packs.
+    /// do nothing with a set of parameters.
+    ///
+    /// useful for temporarily silencing unused argument warnings in parameter
+    /// packs.
+    ///
+    /// it is guaranteed that this function will never be defined out in
+    /// debug/release/whatever builds. so it is safe to use to guarantee
+    /// parameter evaluation.
     void
     ignore (void)
     { ; }