fix: use vendorized messages in doctests

Signed-off-by: Esteve Fernandez <[email protected]>

Author: esteve

rclrs/src/client.rs

@@ -159,12 +159,10 @@ where
     /// signatures and which returns a `()` (a.k.a. nothing).
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::test_msgs::srv::{Empty, Empty_Request, Empty_Response};
     /// # let node = Context::default()
     /// #   .create_basic_executor()
     /// #   .create_node("test_node")?;
-    /// # The following line of code is only needed for rclrs internal purposes,
-    /// # please use the test_msgs crate instead.
-    /// use vendor::test_msgs::srv::{Empty, Empty_Request, Empty_Response};
     ///
     /// async fn print_hello(_response: Empty_Response) {
     ///     print!("Hello!");
@@ -189,13 +187,11 @@ where
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::test_msgs::srv::{Empty, Empty_Request, Empty_Response};
     /// # use std::future::Future;
     /// # let node = Context::default()
     /// #   .create_basic_executor()
     /// #   .create_node("test_node")?;
-    /// # The following line of code is only needed for rclrs internal purposes,
-    /// # please use the test_msgs crate instead.
-    /// use vendor::test_msgs::srv::{Empty, Empty_Request, Empty_Response};
     ///
     /// fn print_greeting(_response: Empty_Response) -> impl Future<Output=()> {
     ///     let greeting = "Hello!";
@@ -220,12 +216,10 @@ where
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::test_msgs::srv::{Empty, Empty_Request, Empty_Response};
     /// # let node = Context::default()
     /// #   .create_basic_executor()
     /// #   .create_node("test_node")?;
-    /// # The following line of code is only needed for rclrs internal purposes,
-    /// # please use the test_msgs crate instead.
-    /// use vendor::test_msgs::srv::{Empty, Empty_Request, Empty_Response};
     ///
     /// let greeting = "Hello!";
     /// let client = node.create_client::<Empty>("my_service")?;

rclrs/src/lib.rs

@@ -32,13 +32,11 @@
 //!
 //! ```no_run
 //! use rclrs::*;
+//! use crate::rclrs::vendor::example_interfaces;
 //!
 //! let context = Context::default_from_env()?;
 //! let mut executor = context.create_basic_executor();
 //! let node = executor.create_node("example_node")?;
-//! # The following line of code is only needed for rclrs internal purposes,
-//! # please use the example_interfaces crate instead.
-//! use vendor::example_interfaces;
 //!
 //! let subscription = node.create_subscription(
 //!     "topic_name",
@@ -61,7 +59,8 @@
 //! # let context = Context::default_from_env()?;
 //! # let mut executor = context.create_basic_executor();
 //! # let node = executor.create_node("example_node")?;
-//! #
+//! # use rclrs::vendor::example_interfaces;
+//!
 //! // This worker will manage the data for us.
 //! // The worker's data is called its payload.
 //! let worker = node.create_worker::<Option<String>>(None);
@@ -100,6 +99,8 @@
 //! The following is a simple example of using a mandatory parameter:
 //! ```no_run
 //! use rclrs::*;
+//! use rclrs::vendor::example_interfaces;
+//!
 //! use std::sync::Arc;
 //!
 //! let mut executor = Context::default_from_env()?.create_basic_executor();
@@ -129,6 +130,7 @@
 //!
 //! ```no_run
 //! use rclrs::*;
+//! use rclrs::vendor::example_interfaces;
 //! use std::time::Duration;
 //!
 //! let mut executor = Context::default_from_env()?.create_basic_executor();
@@ -192,7 +194,7 @@ mod service;
 mod subscription;
 mod time;
 mod time_source;
-mod vendor;
+pub mod vendor;
 mod wait_set;
 mod worker;
 

rclrs/src/node.rs

@@ -244,6 +244,7 @@ impl NodeState {
     /// In some cases the payload type can be inferred by Rust:
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces;
     /// let executor = Context::default().create_basic_executor();
     /// let node = executor.create_node("my_node").unwrap();
     ///
@@ -269,6 +270,7 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     /// let worker = node.create_worker::<String>(String::new());
@@ -277,6 +279,7 @@ impl NodeState {
     /// The data given to the worker can be any custom data type:
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     ///
@@ -312,6 +315,7 @@ impl NodeState {
     /// # use rclrs::*;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
+    /// # use rclrs::vendor::test_msgs;
     /// let client = node.create_client::<test_msgs::srv::Empty>(
     ///     "my_service"
     /// )
@@ -325,6 +329,7 @@ impl NodeState {
     /// # use rclrs::*;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
+    /// # use rclrs::vendor::test_msgs;
     /// let client = node.create_client::<test_msgs::srv::Empty>(
     ///     "my_service"
     ///     .keep_all()
@@ -357,6 +362,7 @@ impl NodeState {
     /// # use rclrs::*;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
+    /// # use rclrs::vendor::test_msgs;
     /// let publisher = node.create_publisher::<test_msgs::msg::Empty>(
     ///     "my_topic"
     /// )
@@ -368,6 +374,7 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::test_msgs;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     /// let publisher = node.create_publisher::<test_msgs::msg::Empty>(
@@ -414,8 +421,10 @@ impl NodeState {
     /// Pass in only the service name for the `options` argument to use all default service options:
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::test_msgs;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
+    ///
     /// let service = node.create_service::<test_msgs::srv::Empty, _>(
     ///     "my_service",
     ///     |_request: test_msgs::srv::Empty_Request| {
@@ -430,8 +439,10 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::test_msgs;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
+    ///
     /// let service = node.create_service::<test_msgs::srv::Empty, _>(
     ///     "my_service"
     ///     .keep_all()
@@ -468,10 +479,10 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces::srv::*;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     /// use std::sync::Mutex;
-    /// use example_interfaces::srv::*;
     ///
     /// let counter = Mutex::new(0usize);
     /// let service = node.create_service::<Trigger, _>(
@@ -494,10 +505,10 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces::srv::*;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     /// use std::sync::{Arc, Mutex};
-    /// use example_interfaces::srv::*;
     ///
     /// let counter = Arc::new(Mutex::new(0usize));
     ///
@@ -588,10 +599,10 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces::srv::*;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node")?;
     /// use std::sync::Arc;
-    /// use example_interfaces::srv::*;
     ///
     /// let worker_a = node.create_worker(0_i64);
     /// let worker_b = node.create_worker(0_i64);
@@ -660,11 +671,9 @@ impl NodeState {
     /// Pass in only the topic name for the `options` argument to use all default subscription options:
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::test_msgs;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
-    /// # The following line of code is only needed for rclrs internal purposes,
-    /// # please use the test_msgs crate instead.
-    /// use vendor::test_msgs;
     /// let subscription = node.create_subscription(
     ///     "my_topic",
     ///     |_msg: test_msgs::msg::Empty| {
@@ -678,11 +687,10 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::test_msgs;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     /// # The following line of code is only needed for rclrs internal purposes,
-    /// # please use the test_msgs crate instead.
-    /// use vendor::test_msgs;
     /// let subscription = node.create_subscription(
     ///     "my_topic"
     ///     .keep_last(100)
@@ -723,6 +731,7 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     /// use std::sync::Mutex;
@@ -745,6 +754,7 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     /// use std::sync::{Arc, Mutex};
@@ -845,8 +855,10 @@ impl NodeState {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
+    ///
     /// use std::sync::Arc;
     ///
     /// let count_worker = node.create_worker(0_usize);

rclrs/src/publisher.rs

@@ -344,8 +344,8 @@ mod tests {
 
     #[test]
     fn test_publishers() -> Result<(), RclrsError> {
-        use crate::TopicEndpointInfo;
         use crate::vendor::test_msgs::msg;
+        use crate::TopicEndpointInfo;
 
         let namespace = "/test_publishers_graph";
         let graph = construct_test_graph(namespace)?;

rclrs/src/service.rs

@@ -400,8 +400,8 @@ mod tests {
 
     #[test]
     fn test_services() -> Result<(), RclrsError> {
-        use crate::TopicNamesAndTypes;
         use crate::vendor::test_msgs::srv;
+        use crate::TopicNamesAndTypes;
 
         let namespace = "/test_services_graph";
         let graph = construct_test_graph(namespace)?;

rclrs/src/subscription.rs

@@ -523,8 +523,8 @@ mod tests {
 
     #[test]
     fn test_delayed_subscription() {
-        use crate::*;
         use crate::vendor::example_interfaces::msg::Empty;
+        use crate::*;
         use futures::{
             channel::{mpsc, oneshot},
             StreamExt,

rclrs/src/vendor/mod.rs

@@ -1,5 +1,6 @@
 //! Created by vendor_interfaces.py
 #![allow(dead_code)]
+#![allow(missing_docs)]
 
 pub mod action_msgs;
 pub mod builtin_interfaces;

rclrs/src/worker.rs

@@ -228,6 +228,7 @@ impl<Payload: 'static + Send + Sync> WorkerState<Payload> {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
     /// // The worker's payload is data that we want to share with other callbacks.
@@ -320,9 +321,9 @@ impl<Payload: 'static + Send + Sync> WorkerState<Payload> {
     ///
     /// ```
     /// # use rclrs::*;
+    /// # use rclrs::vendor::example_interfaces::srv::*;
     /// # let executor = Context::default().create_basic_executor();
     /// # let node = executor.create_node("my_node").unwrap();
-    /// use example_interfaces::srv::*;
     ///
     /// /// Store the operands of the service request for later reference
     /// #[derive(Default)]
@@ -500,12 +501,12 @@ impl<Payload: 'static + Send + Sync> WorkScope for Worker<Payload> {
 
 #[cfg(test)]
 mod tests {
-    use crate::*;
-    use std::time::Duration;
     use crate::vendor::test_msgs::{
         msg::Empty as EmptyMsg,
         srv::{Empty as EmptySrv, Empty_Request, Empty_Response},
     };
+    use crate::*;
+    use std::time::Duration;
 
     #[derive(Default, Clone, Copy, Debug)]
     struct TestPayload {

rclrs/vendor_interfaces.py

@@ -63,6 +63,7 @@ def main():
 
   mod_contents = "//! Created by {}\n".format(Path(__file__).name)
   mod_contents += "#![allow(dead_code)]\n"
+  mod_contents += "#![allow(missing_docs)]\n"
   mod_contents += "\n"
   for pkg in vendored_packages:
     mod_contents += f"pub mod {pkg};\n"