From b75803ad66c1cfec04f35ffdd1bb0608ae2899ba Mon Sep 17 00:00:00 2001
From: GueLaKais <koroyeldiores@gmail.com>
Date: Wed, 13 Aug 2025 10:35:18 +0200
Subject: [PATCH] added example to RclrsError

---
 rclrs/src/error.rs | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/rclrs/src/error.rs b/rclrs/src/error.rs
index b177aaafa..4dde5893a 100644
--- a/rclrs/src/error.rs
+++ b/rclrs/src/error.rs
@@ -4,12 +4,20 @@ use std::{
     fmt::{self, Display},
 };
 
-use crate::{rcl_bindings::*, DeclarationError};
+use crate::{DeclarationError, rcl_bindings::*};
 
 /// The main error type.
 #[derive(Debug, PartialEq, Eq)]
 pub enum RclrsError {
     /// An error originating in the `rcl` layer.
+    /// Example:    
+    /// ```rust
+    /// let error: RclrsError = RclrsError::RclError { code: RclReturnCode::Timeout, msg: None };
+    /// match &error {
+    ///     RclrsError::RclError { msg, .. } => assert_eq!(msg, &None),
+    ///     _ => panic!("Unexpected error variant"),
+    /// }
+    /// ```
     RclError {
         /// The error code.
         code: RclReturnCode,