add a bit of doc

freckle · Jul 3, 2024 · 3fd04b7 · 3fd04b7
1 parent 53c3259
commit 3fd04b7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/library/GitHub/Workflow/Command/Syntax.hs b/library/GitHub/Workflow/Command/Syntax.hs
@@ -8,10 +8,10 @@ module GitHub.Workflow.Command.Syntax
   , Message
 
     -- * Working with commands
-  , TextIso (..)
   , command
-  , HasMessage (..)
   , property
+  , TextIso (..)
+  , HasMessage (..)
   , HasProperties (..)
 
     -- * Printing commands

diff --git a/library/GitHub/Workflow/Command/Syntax/Command.hs b/library/GitHub/Workflow/Command/Syntax/Command.hs
@@ -32,6 +32,11 @@ instance HasMessage Command where
 instance HasProperties Command where
   properties = lens (.properties) \x y -> x {properties = y}
 
+-- | Construct a minimal command with a command 'Name' e.g. "warning" or "error"
+--
+-- See the 'GitHub.Workflow.Command.Syntax.Properties.property' and
+-- 'GitHub.Workflow.Command.Syntax.Message.message' lenses for other
+-- information include in a command.
 command :: Name -> Command
 command x =
   Command