Skip to content

Commit ba3d941

Browse files
Remove docstring test
1 parent 620d09d commit ba3d941

File tree

1 file changed

+0
-29
lines changed

1 file changed

+0
-29
lines changed

rclrs/src/parameter/structured.rs

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,6 @@
11
//! This module provides the trait [`StructuredParameters`] default implementations for declaring parameters in structured fashion.
22
//! [`rclrs_proc_macros::StructuredParameters`] provides a macro to derive the trait for structs automatically.
33
//!
4-
//! # Example
5-
//! ```
6-
//! use rclrs::*;
7-
//! use rclrs_proc_macros::StructuredParameters;
8-
//!
9-
//! #[derive(StructuredParameters, Debug)]
10-
//! pub struct SimpleStructuredParameters {
11-
//! #[param(description = "optional parameter description")]
12-
//! pub optional: rclrs::OptionalParameter<f64>,
13-
//! }
14-
//! #[derive(StructuredParameters, Debug)]
15-
//! pub struct NestedStructuredParameters {
16-
//! pub simple: SimpleStructuredParameters,
17-
//! #[param(default = Arc::from("test"))]
18-
//! pub mandatory: rclrs::MandatoryParameter<Arc<str>>,
19-
//! }
20-
//! let args: Vec<String> = [
21-
//! "test", "--ros-args",
22-
//! "-p", "mandatory:=override",
23-
//! "-p", "simple.optional:=3.14",
24-
//! ].into_iter().map(str::to_string).collect();
25-
//! let context = crate::Context::new(args, rclrs::InitOptions::default()).unwrap();
26-
//! let exec = context.create_basic_executor();
27-
//! let node = exec.create_node(rclrs::NodeOptions::new("test")).unwrap();
28-
//! let params: NestedStructuredParameters =
29-
//! node.declare_parameters("").unwrap();
30-
//! let param = params.simple.optional.get();
31-
//! println!("{:?}", param)
32-
//! ```
334
345
use crate::NodeState;
356

0 commit comments

Comments
 (0)