From 796b2f480a8cb6e08b5f4cc331d3df8fec5ff771 Mon Sep 17 00:00:00 2001
From: zhouyuan chen <867442167@qq.com>
Date: Sun, 28 Apr 2024 11:07:54 -0400
Subject: [PATCH] add a comment

---
 src/wmtk/operations/EdgeSplit.hpp | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/wmtk/operations/EdgeSplit.hpp b/src/wmtk/operations/EdgeSplit.hpp
index 3d1a7aadd9..cf96b357d5 100644
--- a/src/wmtk/operations/EdgeSplit.hpp
+++ b/src/wmtk/operations/EdgeSplit.hpp
@@ -5,7 +5,6 @@
 #include "attribute_new/SplitNewAttributeStrategy.hpp"
 
 namespace wmtk::operations {
-
 class EdgeSplit : public Operation
 {
 public:
@@ -30,6 +29,9 @@ class EdgeSplit : public Operation
         const wmtk::operations::SplitRibBasicStrategy& rib =
             wmtk::operations::SplitRibBasicStrategy::Default);
 
+    /**
+     * @return the new simplex, toward to the next simplex along the splited line
+     */
     std::vector<simplex::Simplex> execute(const simplex::Simplex& simplex) override;
     std::vector<simplex::Simplex> unmodified_primitives(
         const simplex::Simplex& simplex) const override;