sha256

commit 4b60f861160b15b88ee5eb1e7f3d0e057776dc77
parent 38bbf6f1a9d4465020adbd517c2bcf32dc822d9c
Author: Jared Tobin <jared@jtobin.io>
Date:   Thu,  8 Jan 2026 18:13:08 +0400

lib: haddock pragmas

Diffstat:
M
lib/Crypto/Hash/SHA256.hs
 | 
5
+++++
M
lib/Crypto/Hash/SHA256/Arm.hs
 | 
1
+
M
lib/Crypto/Hash/SHA256/Internal.hs
 | 
2
+-
M
lib/Crypto/Hash/SHA256/Lazy.hs
 | 
2
+-

4 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/lib/Crypto/Hash/SHA256.hs b/lib/Crypto/Hash/SHA256.hs
@@ -1,3 +1,4 @@
+{-# OPTIONS_HADDOCK prune #-}
 {-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE MagicHash #-}
 {-# LANGUAGE PatternSynonyms #-}
@@ -14,6 +15,10 @@
 -- strict and lazy ByteStrings, as specified by RFC's
 -- [6234](https://datatracker.ietf.org/doc/html/rfc6234) and
 -- [2104](https://datatracker.ietf.org/doc/html/rfc2104).
+--
+-- The 'hash' and 'hmac' functions will use primitive instructions from
+-- the ARM cryptographic extensions via FFI if they're available, and
+-- will otherwise use a pure Haskell implementation.
 
 module Crypto.Hash.SHA256 (
   -- * SHA-256 message digest functions
diff --git a/lib/Crypto/Hash/SHA256/Arm.hs b/lib/Crypto/Hash/SHA256/Arm.hs
@@ -1,3 +1,4 @@
+{-# OPTIONS_HADDOCK hide #-}
 {-# LANGUAGE BangPatterns #-}
 
 -- |
diff --git a/lib/Crypto/Hash/SHA256/Internal.hs b/lib/Crypto/Hash/SHA256/Internal.hs
@@ -1,4 +1,4 @@
-{-# OPTIONS_GHC -funbox-small-strict-fields #-}
+{-# OPTIONS_HADDOCK hide #-}
 {-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE MagicHash #-}
 {-# LANGUAGE PatternSynonyms #-}
diff --git a/lib/Crypto/Hash/SHA256/Lazy.hs b/lib/Crypto/Hash/SHA256/Lazy.hs
@@ -1,4 +1,4 @@
-{-# OPTIONS_GHC -funbox-small-strict-fields #-}
+{-# OPTIONS_HADDOCK hide #-}
 {-# LANGUAGE BangPatterns #-}
 {-# LANGUAGE ViewPatterns #-}