Document that HideSuccesses is only valid as a global option

UnkindPartition#231
quchen · Feb 4, 2022 · eb4c684 · eb4c684
1 parent 164cdc8
commit eb4c684
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/core/Test/Tasty/Ingredients/ConsoleReporter.hs b/core/Test/Tasty/Ingredients/ConsoleReporter.hs
@@ -502,7 +502,9 @@ instance IsOption Quiet where
   optionHelp = return "Do not produce any output; indicate success only by the exit code"
   optionCLParser = mkFlagCLParser (short 'q') (Quiet True)
 
--- | Report only failed tests
+-- | Report only failed tests.
+--
+-- At the moment, this option only works globally. As an argument to 'localOption', it does nothing.
 newtype HideSuccesses = HideSuccesses Bool
   deriving (Eq, Ord, Typeable)
 instance IsOption HideSuccesses where