From 10d04c4153b8cf25eec88e8e005b95b35e5ff128 Mon Sep 17 00:00:00 2001
From: Ryan Curtin <ryan@ratml.org>
Date: Sun, 3 Apr 2022 15:57:02 -0400
Subject: [PATCH] Add clarifying comment about where MakeAlias() is used.

---
 src/mlpack/methods/ann/make_alias.hpp | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/mlpack/methods/ann/make_alias.hpp b/src/mlpack/methods/ann/make_alias.hpp
index 411af1e585..65b68565d3 100644
--- a/src/mlpack/methods/ann/make_alias.hpp
+++ b/src/mlpack/methods/ann/make_alias.hpp
@@ -2,7 +2,9 @@
  * @file make_alias.hpp
  * @author Ryan Curtin
  *
- * Implementation of MakeAlias(), a utility function.
+ * Implementation of `MakeAlias()`, a utility function.  This is meant to be
+ * used in `SetWeights()` calls in various layers, to wrap internal weight
+ * objects as aliases around the given memory pointers.
  */
 #ifndef MLPACK_METHODS_ANN_MAKE_ALIAS_HPP
 #define MLPACK_METHODS_ANN_MAKE_ALIAS_HPP