Add module headers to modules with docs

restyled-io · Aug 9, 2024 · 368971b · 368971b
1 parent 7a770f6
commit 368971b
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 0 deletions.
diff --git a/src/GHC/Generics/Selectors.hs b/src/GHC/Generics/Selectors.hs
@@ -5,6 +5,13 @@
 -- | Function for getting the names of fields in a type
 --
 -- <https://stackoverflow.com/questions/27815489/is-it-possible-to-list-the-names-and-types-of-fields-in-a-record-data-type-that>
+--
+-- Module      : GHC.Generics.Selectors
+-- Copyright   : (c) 2024 Patrick Brisbin
+-- License     : AGPL-3
+-- Maintainer  : pbrisbin@gmail.com
+-- Stability   : experimental
+-- Portability : POSIX
 module GHC.Generics.Selectors
   ( Selectors (..)
   ) where

diff --git a/src/Restyler/Config.hs b/src/Restyler/Config.hs
@@ -18,6 +18,13 @@
 -- - <https://reasonablypolymorphic.com/blog/higher-kinded-data/>
 -- - <https://chrispenner.ca/posts/hkd-options>
 -- - <https://hackage.haskell.org/package/barbies>
+--
+-- Module      : Restyler.Config
+-- Copyright   : (c) 2024 Patrick Brisbin
+-- License     : AGPL-3
+-- Maintainer  : pbrisbin@gmail.com
+-- Stability   : experimental
+-- Portability : POSIX
 module Restyler.Config
   ( Config (..)
   , ConfigError (..)

diff --git a/src/Restyler/Config/Glob.hs b/src/Restyler/Config/Glob.hs
@@ -1,6 +1,13 @@
 {-# LANGUAGE AllowAmbiguousTypes #-}
 
 -- | Small wrapper over @'System.FilePath.Glob.Pattern'@
+--
+-- Module      : Restyler.Config.Glob
+-- Copyright   : (c) 2024 Patrick Brisbin
+-- License     : AGPL-3
+-- Maintainer  : pbrisbin@gmail.com
+-- Stability   : experimental
+-- Portability : POSIX
 module Restyler.Config.Glob
   ( Glob (..)
   , GlobTarget (..)

diff --git a/src/Restyler/Local.hs b/src/Restyler/Local.hs
@@ -1,4 +1,11 @@
 -- | @restyle PATH [PATH...]@
+--
+-- Module      : Restyler.Local
+-- Copyright   : (c) 2024 Patrick Brisbin
+-- License     : AGPL-3
+-- Maintainer  : pbrisbin@gmail.com
+-- Stability   : experimental
+-- Portability : POSIX
 module Restyler.Local
   ( NullPullRequest (..)
   , run

diff --git a/test/Restyler/Test/FS.hs b/test/Restyler/Test/FS.hs
@@ -12,6 +12,13 @@
 --   common prefix shared by multiple files. An empty directory can be created
 --   by creating a file ending in @/@. Therefore, reading and writing to a
 --   \"directory\" could behave in surprising ways.
+--
+-- Module      : Restyler.Test.FS
+-- Copyright   : (c) 2024 Patrick Brisbin
+-- License     : AGPL-3
+-- Maintainer  : pbrisbin@gmail.com
+-- Stability   : experimental
+-- Portability : POSIX
 module Restyler.Test.FS
   ( FS
   , build