From 13b6c20e7bb6eddcf1213d7b6545030382e7746c Mon Sep 17 00:00:00 2001
From: Didactic Drunk <1479616+didactic-drunk@users.noreply.github.com>
Date: Tue, 15 Jun 2021 20:17:38 -0700
Subject: [PATCH] Update class documentation

---
 README.md                  |  2 +-
 src/crypto-secret/bidet.cr | 10 +++++-----
 src/crypto-secret/not.cr   | 14 +++++++-------
 3 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 5c1ef88..2085bb3 100644
--- a/README.md
+++ b/README.md
@@ -88,7 +88,7 @@ That's complicated and specific to the application.  Some examples:
 Not secrets:
 
 * Digest output.  Except when used for key derivation, then it's a Secret, including the Digest state
-* IO::Memory or writing a file.  Except when the file is a password vault, cryptocurrency wallet, encrypted mail/messages, goat porn, maybe "normal" porn, sometimes scat porn, occassionally furry, not vanilla porn
+* IO::Memory or writing a file.  Except when the file is a password vault, cryptocurrency wallet, encrypted mail/messages, goat porn, maybe "normal" porn, sometimes scat porn, occassionally furry, not people porn
 
 ## Why?
 
diff --git a/src/crypto-secret/bidet.cr b/src/crypto-secret/bidet.cr
index 468ee5d..d035187 100644
--- a/src/crypto-secret/bidet.cr
+++ b/src/crypto-secret/bidet.cr
@@ -1,11 +1,11 @@
 require "./stateless"
 
-# Leaves less sh** around if you forget to wipe.  A safer default for large secrets that may stress mlock limits or low confidentiality secrets.
-#
-# * Not locked in memory
-# * Not access protected
-# * No guard pages
 module Crypto::Secret
+  # Leaves less sh** around if you forget to wipe.  A safer default for large secrets that may stress mlock limits or low confidentiality secrets.
+  #
+  # * Not locked in memory
+  # * Not access protected
+  # * No guard pages
   class Bidet
     include Stateless
 
diff --git a/src/crypto-secret/not.cr b/src/crypto-secret/not.cr
index 7d6a44c..d5c8ee3 100644
--- a/src/crypto-secret/not.cr
+++ b/src/crypto-secret/not.cr
@@ -1,13 +1,13 @@
 require "./stateless"
 
-# A not very secret secret, but fast
-#
-# * 0 overhead
-# * Not locked in memory
-# * Not access protected
-# * No guard pages
-# * No wiping
 module Crypto::Secret
+  # A not very secret `Secret`, but fast
+  #
+  # * 0 overhead
+  # * Not locked in memory
+  # * Not access protected
+  # * No guard pages
+  # * No wiping
   struct Not
     include Stateless