remove restore keys (#53)

Author: Kleidukos

.github/workflows/ci.yml

@@ -48,7 +48,6 @@ jobs:
         with:
           path: ${{ steps.setup-haskell.outputs.cabal-store }}
           key: ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('cabal.project.freeze') }}
-          restore-keys: ${{ runner.os }}-${{ matrix.ghc }}-
       - name: Build
         run: cabal new-build
       - name: Test

src/Data/Text/Display.hs

@@ -26,3 +26,39 @@ where
 
 import Data.Text.Display.Core
 import Data.Text.Display.Generic
+
+-- $designChoices
+--
+-- === A “Lawless Typeclass”
+--
+-- The 'Display' typeclass does not contain any law. This is a controversial choice for some people,
+-- but the truth is that there are not any laws to ask of the consumer that are not already enforced
+-- by the type system and the internals of the 'Data.Text.Internal.Text' type.
+--
+-- === "🚫 You should not try to display functions!"
+--
+-- Sometimes, when using the library, you may encounter this message:
+--
+-- > • 🚫 You should not try to display functions!
+-- >   💡 Write a 'newtype' wrapper that represents your domain more accurately.
+-- >      If you are not consciously trying to use `display` on a function,
+-- >      make sure that you are not missing an argument somewhere.
+--
+-- The 'display' library does not allow the definition and usage of 'Display' on
+-- bare function types (@(a -> b)@).
+-- Experience and time have shown that due to partial application being baked in the language,
+-- many users encounter a partial application-related error message when a simple missing
+-- argument to a function is the root cause.
+--
+-- There may be legitimate uses of a 'Display' instance on a function type.
+-- But these usages are extremely dependent on their domain of application.
+-- That is why it is best to wrap them in a newtype that can better
+-- express and enforce the domain.
+--
+-- === "🚫 You should not try to display ByteStrings!"
+--
+-- An arbitrary ByteStrings cannot be safely converted to text without prior knowledge of its encoding.
+--
+-- As such, in order to avoid dangerously blind conversions, it is recommended to use a specialised
+-- function such as 'Data.Text.Encoding.decodeUtf8'' or 'Data.Text.Encoding.decodeUtf8With' if you wish to turn a UTF8-encoded ByteString
+-- to Text.

text-display.cabal

@@ -61,7 +61,10 @@ library
   import:          common-extensions
   import:          common-ghc-options
   hs-source-dirs:  src
-  exposed-modules: Data.Text.Display
+  exposed-modules:
+    Data.Text.Display
+    Data.Text.Display.Core
+    Data.Text.Display.Generic
   build-depends:
     , base        >=4.12 && <5.0
     , bytestring  >=0.10 && <0.12