Browse Source

Document public `DYNAMIC_SOURCE` constant (#1082)

Also set `#![warn(missing_docs)]` for the module so that we get a
warning if we add undocumented fields etc in the future.
pull/1086/head
Philipp Oppermann GitHub 6 months ago
parent
commit
bc41743311
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
  1. +4
    -0
      libraries/message/src/descriptor.rs

+ 4
- 0
libraries/message/src/descriptor.rs View File

@@ -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


Loading…
Cancel
Save