From ff53750cab6b6e20a3e681c3bf5ce0883d7102c9 Mon Sep 17 00:00:00 2001
From: Chiu Yue Chun <chiubrian@link.cuhk.edu.hk>
Date: Wed, 4 Oct 2017 00:28:32 +0800
Subject: [PATCH] Additional notes on Crypter

---
 openssl/src/symm.rs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/openssl/src/symm.rs b/openssl/src/symm.rs
index ee1b0621..14ee392b 100644
--- a/openssl/src/symm.rs
+++ b/openssl/src/symm.rs
@@ -244,11 +244,13 @@ pub struct Crypter {
 }
 
 impl Crypter {
-    /// Creates a new `Crypter`.
+    /// Creates a new `Crypter`.  The initialisation vector, `iv`, is not necesarry for certain
+    /// types of `Cipher`.
     ///
     /// # Panics
     ///
-    /// Panics if an IV is required by the cipher but not provided.
+    /// Panics if an IV is required by the cipher but not provided.  Also make sure that the key
+    /// and IV size are appropriate for your cipher.
     pub fn new(
         t: Cipher,
         mode: Mode,