Updated Core Documentation

emsec · Oct 18, 2023 · ad485b8 · ad485b8
1 parent 6887e77
commit ad485b8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/include/hal_core/netlist/netlist.h b/include/hal_core/netlist/netlist.h
@@ -476,6 +476,7 @@ namespace hal
 
         /**
          * Remove a module from the netlist.
+         * Submodules, gates and nets under this module will be moved to the parent of this module.
          *
          * @param[in] module - The module.
          * @returns True on success, false otherwise.

diff --git a/src/python_bindings/bindings/netlist.cpp b/src/python_bindings/bindings/netlist.cpp
@@ -517,6 +517,7 @@ namespace hal
 
         py_netlist.def("delete_module", &Netlist::delete_module, py::arg("module"), R"(
             Remove a module from the netlist.
+            Submodules, gates and nets under this module will be moved to the parent of this module.
 
             :param module: The module.
             :type module: hal_py.Module