From 3fd04b78a9fdc6370d8a75ffc3d43e4023233995 Mon Sep 17 00:00:00 2001
From: Chris Martin <chris.martin@renaissance.com>
Date: Wed, 3 Jul 2024 13:14:20 -0600
Subject: [PATCH] add a bit of doc

---
 library/GitHub/Workflow/Command/Syntax.hs         | 4 ++--
 library/GitHub/Workflow/Command/Syntax/Command.hs | 5 +++++
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/library/GitHub/Workflow/Command/Syntax.hs b/library/GitHub/Workflow/Command/Syntax.hs
index 9deb926..1a153bf 100644
--- 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
index 769e103..c571fed 100644
--- 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