Remove ineffectual description builder modifiers.

These haven't done anything since 0.8.

Author: HuwCampbell

CHANGELOG.md

@@ -3,6 +3,8 @@
 - Fix for showHelpOnEmpty so that it works correctly when subParserInline is
   also active.
 
+- Remove `fullDesc` and `briefDesc` builder modifiers – they have not had an
+  effect since version 0.8.
 
 ## Version 0.19.0.0 (03 June 2025)
 

src/Options/Applicative.hs

@@ -157,8 +157,6 @@ module Options.Applicative (
   ParserInfo(..),
 
   InfoMod,
-  fullDesc,
-  briefDesc,
   header,
   headerDoc,
   footer,

src/Options/Applicative/Builder.hs

@@ -64,8 +64,6 @@ module Options.Applicative.Builder (
 
   -- * Builder for 'ParserInfo'
   InfoMod,
-  fullDesc,
-  briefDesc,
   header,
   headerDoc,
   footer,
@@ -443,14 +441,6 @@ instance Monoid (InfoMod a) where
 instance Semigroup (InfoMod a) where
   m1 <> m2 = InfoMod $ applyInfoMod m2 . applyInfoMod m1
 
--- | Show a full description in the help text of this parser (default).
-fullDesc :: InfoMod a
-fullDesc = InfoMod $ \i -> i { infoFullDesc = True }
-
--- | Only show a brief description in the help text of this parser.
-briefDesc :: InfoMod a
-briefDesc = InfoMod $ \i -> i { infoFullDesc = False }
-
 -- | Specify a header for this parser.
 header :: String -> InfoMod a
 header s = InfoMod $ \i -> i { infoHeader = paragraph s }
@@ -513,7 +503,6 @@ info parser m = applyInfoMod m base
   where
     base = ParserInfo
       { infoParser = parser
-      , infoFullDesc = True
       , infoProgDesc = mempty
       , infoHeader = mempty
       , infoFooter = mempty

src/Options/Applicative/Help/Levenshtein.hs

@@ -1,3 +1,5 @@
+{-# OPTIONS_GHC -Wno-unrecognised-warning-flags #-}
+{-# OPTIONS_GHC -Wno-x-partial #-}
 module Options.Applicative.Help.Levenshtein (
     editDistance
   ) where

src/Options/Applicative/Types.hs

@@ -89,8 +89,6 @@ instance Semigroup ParseError where
 -- | A full description for a runnable 'Parser' for a program.
 data ParserInfo a = ParserInfo
   { infoParser :: Parser a    -- ^ the option parser for the program
-  , infoFullDesc :: Bool      -- ^ whether the help text should contain full
-                              -- documentation
   , infoProgDesc :: Chunk Doc -- ^ brief parser description
   , infoHeader :: Chunk Doc   -- ^ header of the full parser description
   , infoFooter :: Chunk Doc   -- ^ footer of the full parser description

tests/Examples/Hello.hs

@@ -33,8 +33,7 @@ main = greet =<< execParser opts
 
 opts :: ParserInfo Sample
 opts = info (sample <**> helper)
-  ( fullDesc
-  <> progDesc "Print a greeting for TARGET"
+  (  progDesc "Print a greeting for TARGET"
   <> header "hello - a test for optparse-applicative" )
 
 greet :: Sample -> IO ()

tests/Examples/ParserGroup/AllGrouped.hs

@@ -80,8 +80,7 @@ opts :: ParserInfo Sample
 opts =
   info
     sample
-    ( fullDesc
-        <> progDesc "Every option is grouped"
+    (  progDesc "Every option is grouped"
         <> header "parser_group.all_grouped - a test for optparse-applicative"
     )
 

tests/Examples/ParserGroup/Basic.hs

@@ -100,8 +100,7 @@ opts :: ParserInfo Sample
 opts =
   info
     (sample <**> helper)
-    ( fullDesc
-        <> progDesc "Shows parser groups"
+    (  progDesc "Shows parser groups"
         <> header "parser_group.basic - a test for optparse-applicative"
     )
 

tests/Examples/ParserGroup/CommandGroups.hs

@@ -123,8 +123,7 @@ opts :: ParserInfo Sample
 opts =
   info
     (sample <**> helper)
-    ( fullDesc
-        <> progDesc "Option and command groups"
+    ( progDesc "Option and command groups"
         <> header "parser_group.command_groups - a test for optparse-applicative"
     )
 

tests/Examples/ParserGroup/DuplicateCommandGroups.hs

@@ -81,8 +81,7 @@ opts :: ParserInfo Sample
 opts =
   info
     (sample <**> helper)
-    ( fullDesc
-        <> progDesc "Duplicate consecutive command groups consolidated"
+    ( progDesc "Duplicate consecutive command groups consolidated"
         <> header "parser_group.duplicate_command_groups - a test for optparse-applicative"
     )