From a75ae6a1fe085bbcedf8631b2ae6f9b6f0a4bfce Mon Sep 17 00:00:00 2001 From: "Ospald, Julian" Date: Tue, 11 Jul 2017 14:48:23 +0200 Subject: [PATCH] Fix documentation --- src/notification.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/notification.rs b/src/notification.rs index e41a5d36..e28afdf2 100644 --- a/src/notification.rs +++ b/src/notification.rs @@ -51,7 +51,7 @@ impl Notification { /// /// # Returns /// - /// `true` on success, or `false` on error with `error` filled in + /// `Ok(())` on success, or `Err(err)` on error pub fn close(&self) -> Result<(), glib::error::Error> { assert_initialized_libnotify!(); unsafe { @@ -70,8 +70,7 @@ impl Notification { /// /// # Returns /// - /// `true` if successful. On error, this will return `false` and set - /// `error`. + /// `Ok(())` on success, or `Err(err)` on error // TODO: test if Error leaks memory pub fn show(&self) -> Result<(), glib::error::Error> { assert_initialized_libnotify!(); @@ -193,6 +192,7 @@ impl Notification { /// # Returns /// /// `true`, unless an invalid parameter was passed. + /// `Ok(())` on success, or `Err(err)` if an invalid parameter was passed pub fn update<'a, 'b, P: Into>, Q: Into>>(&self, summary: &str, body: P, icon: Q) -> Result<(), glib::error::BoolError> { let body = body.into(); let body = body.to_glib_none();