From b2f2e297c2f7d9cf04005bf5c0a76f923b1d4140 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20B=C3=B8cker-Larsen?= Date: Mon, 21 Dec 2020 11:21:40 +0800 Subject: [PATCH] docs: improve docs --- src/client.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/client.rs b/src/client.rs index 8b94376..0637514 100644 --- a/src/client.rs +++ b/src/client.rs @@ -110,7 +110,7 @@ impl<'a, T: Read + Write> AppendCmd<'a, T> { self } - /// Append an array of flags + /// Set multiple flags at once. pub fn flags(&mut self, flags: impl IntoIterator>) -> &mut Self { self.flags.extend(flags); self @@ -126,7 +126,10 @@ impl<'a, T: Read + Write> AppendCmd<'a, T> { self } - /// Run command + /// Finishes up the command and executes it. + /// + /// Note: be sure to set flags and optional date before you + /// finish the command. pub fn finish(&mut self) -> Result<()> { let flagstr = self .flags