From b04b066ce1678e7613c86714f0ab5b729c33065b Mon Sep 17 00:00:00 2001
From: Octave Perrin <operrin@lrtechnologies.fr>
Date: Mon, 18 Nov 2024 14:48:43 +0100
Subject: [PATCH] python binds correct syntax
---
python_binding/graph/pybind_GraphView.cpp | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/python_binding/graph/pybind_GraphView.cpp b/python_binding/graph/pybind_GraphView.cpp
index 318d93aef..5dc8a1a40 100644
--- a/python_binding/graph/pybind_GraphView.cpp
+++ b/python_binding/graph/pybind_GraphView.cpp
@@ -60,6 +60,7 @@ void init_GraphView(py::module& m) {
Orders the inputs of the GraphView
The inputs will be ordered in the same order as they come in the std::vector.
Inputs missing from this vector will then be added as per their previous order.
+
:param inputs: set of inputs in the wanted order
:type inputs: List[(Node, int)]
)mydelimiter")
@@ -69,6 +70,7 @@ void init_GraphView(py::module& m) {
Orders the outputs of the GraphView
The outputs will be ordered in the same order as they come in the std::vector.
Outputs missing from this vector will then be added as per their previous order.
+
:param outputs: set of outputs in the wanted order
:type outputs: List[(Node, int)]
)mydelimiter")
@@ -146,6 +148,7 @@ void init_GraphView(py::module& m) {
When a Node is removed, the clone() method automatically finds the next valid parent in line, going backward in
the graph and connects it if that makes sense without ambiguity (effectively treating the removed Node as an
identity operation).
+
:param cloneNode Callback function to clone a node
:type cloneNode Node
:return: Cloned GraphView
@@ -160,6 +163,7 @@ void init_GraphView(py::module& m) {
.def("get_node", &GraphView::getNode, py::arg("node_name"),
R"mydelimiter(
Get the Node with the corresponding name if it is in the GraphView.
+
:param node_name The name of the Node
:type string
:return: The Node of the GraphView with corresponding name
--
GitLab