From 42ac485354148b165b08f64fac17d60651b06df5 Mon Sep 17 00:00:00 2001
From: Jeremiah Russell <jerry@jrussell.ie>
Date: Mon, 13 Oct 2025 16:47:48 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(delete):=20add=20documentat?=
 =?UTF-8?q?ion=20for=20delete=20trait?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- add documentation to explain the purpose of the trait
- add documentation for `batch_delete` method
- add documentation for `prepare` method
---
 src/delete.rs | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/delete.rs b/src/delete.rs
index da2f3ff..90d2c92 100644
--- a/src/delete.rs
+++ b/src/delete.rs
@@ -2,15 +2,17 @@ use google_gmail1::api::BatchDeleteMessagesRequest;
 
 use crate::{GmailClient, Result, message_list::MessageList};
 
-// /// Struct for deleting messages
 // #[derive(Debug)]
 // pub struct Delete {
 //     message_list: MessageList,
 // }
 
-pub(crate) trait Delete {
-    async fn batch_delete(&self) -> Result<()>;
-    async fn prepare(&mut self, pages: u32) -> Result<()>;
+/// Methods to process items
+pub trait Delete {
+    /// Batch delete of messages
+    fn batch_delete(&self) -> impl std::future::Future<Output = Result<()>> + Send;
+    /// Prepare a list of messages to trash or delete
+    fn prepare(&mut self, pages: u32) -> impl std::future::Future<Output = Result<()>> + Send;
 }
 
 impl Delete for GmailClient {