From 947b7c1233772027c3f753ed63eab08faf3934a8 Mon Sep 17 00:00:00 2001 From: Philipp Oppermann Date: Wed, 23 Jul 2025 12:53:19 +0200 Subject: [PATCH] Document public `DYNAMIC_SOURCE` constant --- libraries/message/src/descriptor.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/libraries/message/src/descriptor.rs b/libraries/message/src/descriptor.rs index 34ddc925..d7ae034e 100644 --- a/libraries/message/src/descriptor.rs +++ b/libraries/message/src/descriptor.rs @@ -1,3 +1,5 @@ +#![warn(missing_docs)] + use crate::{ config::{CommunicationConfig, Input, InputMapping, NodeRunConfig}, id::{DataId, NodeId, OperatorId}, @@ -12,6 +14,8 @@ use std::{ }; pub const SHELL_SOURCE: &str = "shell"; +/// Set the [`Node::path`] field to this value to treat the node as a +/// [_dynamic node_](https://docs.rs/dora-node-api/latest/dora_node_api/). pub const DYNAMIC_SOURCE: &str = "dynamic"; /// # Dataflow Specification