From d5706346d7e95984a003bfeedf1b8ffed6dd9422 Mon Sep 17 00:00:00 2001
From: Lioncash <mathew1800@gmail.com>
Date: Tue, 15 Oct 2019 14:56:15 -0400
Subject: common/algorithm: Add description comment indicating intended
 algorithms

Makes it explicit that the header is intended for iterator-based
algorithms that can ideally operate on any type.
---
 src/common/algorithm.h | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/common')

diff --git a/src/common/algorithm.h b/src/common/algorithm.h
index 18e7ece98..e21b1373c 100644
--- a/src/common/algorithm.h
+++ b/src/common/algorithm.h
@@ -7,6 +7,11 @@
 #include <algorithm>
 #include <functional>
 
+// Algorithms that operate on iterators, much like the <algorithm> header.
+//
+// Note: If the algorithm is not general-purpose and/or doesn't operate on iterators,
+//       it should probably not be placed within this header.
+
 namespace Common {
 
 template <class ForwardIt, class T, class Compare = std::less<>>
-- 
cgit v1.2.3