From 09d512ae4878b767ac1ac5e674795c4ec83f14e6 Mon Sep 17 00:00:00 2001
From: Varun Agrawal <varagrawal@gmail.com>
Date: Thu, 9 Jun 2022 20:11:30 -0400
Subject: [PATCH] add docstring for makeBinaryOrdering

---
 gtsam/hybrid/tests/Switching.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/gtsam/hybrid/tests/Switching.h b/gtsam/hybrid/tests/Switching.h
index 545259e48..38a327a58 100644
--- a/gtsam/hybrid/tests/Switching.h
+++ b/gtsam/hybrid/tests/Switching.h
@@ -173,7 +173,10 @@ inline HybridGaussianFactorGraph::shared_ptr makeSwitchingChain(
 }
 
 /**
- * @brief
+ * @brief Return the ordering as a binary tree such that all parent nodes are
+ * above their children.
+ *
+ * This will result in a nested dissection Bayes tree after elimination.
  *
  * @param input The original ordering.
  * @return std::pair<KeyVector, std::vector<int>>