From 482b282d92dee16e89da6c2ee7bcb36d7bcc446c Mon Sep 17 00:00:00 2001 From: Philipp Oppermann Date: Mon, 5 Jun 2023 09:10:45 +0200 Subject: [PATCH] Document `dataflow_descriptor` methods --- apis/python/node/src/lib.rs | 3 +++ apis/rust/node/src/node/mod.rs | 3 +++ 2 files changed, 6 insertions(+) diff --git a/apis/python/node/src/lib.rs b/apis/python/node/src/lib.rs index d8266344..af77bf08 100644 --- a/apis/python/node/src/lib.rs +++ b/apis/python/node/src/lib.rs @@ -84,6 +84,9 @@ impl Node { }) } + /// Returns the full dataflow descriptor that this node is part of. + /// + /// This method returns the parsed dataflow YAML file. pub fn dataflow_descriptor(&self, py: Python) -> pythonize::Result { pythonize::pythonize(py, self.node.dataflow_descriptor()) } diff --git a/apis/rust/node/src/node/mod.rs b/apis/rust/node/src/node/mod.rs index 75004099..5e637489 100644 --- a/apis/rust/node/src/node/mod.rs +++ b/apis/rust/node/src/node/mod.rs @@ -246,6 +246,9 @@ impl DoraNode { } } + /// Returns the full dataflow descriptor that this node is part of. + /// + /// This method returns the parsed dataflow YAML file. pub fn dataflow_descriptor(&self) -> &Descriptor { &self.dataflow_descriptor }