remove unecessary extra CLI comments

cardano-foundation · Jul 17, 2019 · c783a42 · c783a42
1 parent a6c96bb
commit c783a42
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 47 deletions.
diff --git a/exe/wallet/http-bridge/Main.hs b/exe/wallet/http-bridge/Main.hs
@@ -140,15 +140,9 @@ main = runCli $ cli $ mempty
 
 {-------------------------------------------------------------------------------
                             Command - 'launch'
-
-  cardano-wallet launch
-    [--network=STRING]
-    [(--port=INT | --random-port)]
-    [--node-port=INT]
-    [--state-dir=DIR]
-    [(--quiet | --verbose )]
 -------------------------------------------------------------------------------}
 
+-- | Arguments for the 'launch' command
 data LaunchArgs = LaunchArgs
     { _network :: Either Local Network
     , _listen :: Listen
@@ -157,7 +151,6 @@ data LaunchArgs = LaunchArgs
     , _verbosity :: Verbosity
     }
 
--- | cardano-wallet launch
 cmdLaunch
     :: Mod CommandFields (IO ())
 cmdLaunch = command "launch" $ info (helper <*> cmd) $ mempty
@@ -210,13 +203,6 @@ cmdLaunch = command "launch" $ info (helper <*> cmd) $ mempty
 
 {-------------------------------------------------------------------------------
                             Command - 'serve'
-
-  cardano-wallet serve
-    [--network=STRING]
-    [(--port=INT | --random-port)]
-    [--node-port=INT]
-    [--database=FILE]
-    [(--quiet | --verbose )]
 -------------------------------------------------------------------------------}
 
 -- | Arguments for the 'serve' command
@@ -228,7 +214,6 @@ data ServeArgs = ServeArgs
     , _verbosity :: Verbosity
     }
 
--- | cardano-wallet serve
 cmdServe
     :: Mod CommandFields (IO ())
 cmdServe = command "serve" $ info (helper <*> cmd) $ mempty

diff --git a/exe/wallet/jormungandr/Main.hs b/exe/wallet/jormungandr/Main.hs
@@ -166,16 +166,9 @@ main = runCli $ cli $ mempty
 
 {-------------------------------------------------------------------------------
                             Command - 'launch'
-
-  cardano-wallet launch
-    [(--port=INT | --random-port)]
-    [--node-port=INT]
-    [--state-dir=DIR]
-    [(--quiet | --verbose )]
-    --genesis-block=FILE
-    --bft-leaders=FILE
 -------------------------------------------------------------------------------}
 
+-- | Arguments for the 'launch' command
 data LaunchArgs = LaunchArgs
     { _listen :: Listen
     , _nodePort :: Port "Node"
@@ -189,7 +182,6 @@ data JormungandrArgs = JormungandrArgs
     , _bftLeaders :: FilePath
     }
 
--- | cardano-wallet launch
 cmdLaunch
     :: Mod CommandFields (IO ())
 cmdLaunch = command "launch" $ info (helper <*> cmd) $ mempty
@@ -267,14 +259,6 @@ parseBlock0H file = do
 
 {-------------------------------------------------------------------------------
                             Command - 'serve'
-
-  cardano-wallet serve
-    [--network=STRING]
-    [(--port=INT | --random-port)]
-    [--node-port=INT]
-    [--database=FILE]
-    [(--quiet | --verbose )]
-    --genesis-hash=STRING
 -------------------------------------------------------------------------------}
 
 -- | Arguments for the 'serve' command
@@ -286,7 +270,6 @@ data ServeArgs = ServeArgs
     , _block0H :: Hash "Genesis"
     }
 
--- | cardano-wallet serve
 cmdServe
     :: Mod CommandFields (IO ())
 cmdServe = command "serve" $ info (helper <*> cmd) $ mempty

diff --git a/lib/cli/src/Cardano/CLI.hs b/lib/cli/src/Cardano/CLI.hs
@@ -271,7 +271,6 @@ runCli = join . customExecParser preferences
                             Commands - 'mnemonic'
 -------------------------------------------------------------------------------}
 
--- | cardano-wallet mnemonic
 cmdMnemonic :: Mod CommandFields (IO ())
 cmdMnemonic = command "mnemonic" $ info (helper <*> cmds) mempty
   where
@@ -283,7 +282,6 @@ newtype MnemonicGenerateArgs = MnemonicGenerateArgs
     { _size :: MnemonicSize
     }
 
--- | cardano-wallet mnemonic generate [--size=INT]
 cmdMnemonicGenerate :: Mod CommandFields (IO ())
 cmdMnemonicGenerate = command "generate" $ info (helper <*> cmd) $ mempty
     <> progDesc "Generate English BIP-0039 compatible mnemonic words."
@@ -303,7 +301,6 @@ cmdMnemonicGenerate = command "generate" $ info (helper <*> cmd) $ mempty
                             Commands - 'wallet'
 -------------------------------------------------------------------------------}
 
--- | cardano-wallet wallet
 cmdWallet
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -321,7 +318,6 @@ newtype WalletListArgs = WalletListArgs
     { _port :: Port "Wallet"
     }
 
--- | cardano-wallet wallet list [--port=INT]
 cmdWalletList
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -339,7 +335,6 @@ data WalletCreateArgs = WalletCreateArgs
     , _gap :: AddressPoolGap
     }
 
--- | cardano-wallet wallet create [--port=INT] <name> [--address-pool-gap=INT]
 cmdWalletCreate
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -380,7 +375,6 @@ data WalletGetArgs = WalletGetArgs
     , _id :: WalletId
     }
 
--- | cardano-wallet wallet get [--port=INT] <wallet-id>
 cmdWalletGet
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -411,7 +405,6 @@ data WalletUpdateNameArgs = WalletUpdateNameArgs
     , _name :: WalletName
     }
 
--- | cardano-wallet wallet update name [--port=INT] <wallet-id> STRING
 cmdWalletUpdateName
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -433,7 +426,6 @@ data WalletUpdatePassphraseArgs = WalletUpdatePassphraseArgs
     , _id :: WalletId
     }
 
--- | cardano-wallet wallet update passphrase [--port=INT] <wallet-id>
 cmdWalletUpdatePassphrase
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -465,7 +457,6 @@ data WalletDeleteArgs = WalletDeleteArgs
     , _id :: WalletId
     }
 
--- | cardano-wallet wallet delete [--port=INT] <wallet-id>
 cmdWalletDelete
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -500,7 +491,6 @@ data TransactionCreateArgs t = TransactionCreateArgs
     , _payments :: NonEmpty (AddressAmount t)
     }
 
--- | cardano-wallet wallet list [--port=INT]
 cmdTransactionCreate
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -548,7 +538,6 @@ cmdTransactionFees = command "fees" $ info (helper <*> cmd) $ mempty
                             Commands - 'address'
 -------------------------------------------------------------------------------}
 
--- | cardano-wallet address
 cmdAddress
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -564,7 +553,6 @@ data AddressListArgs = AddressListArgs
     , _id :: WalletId
     }
 
--- | cardano-wallet address list [--port=INT] [--state=STRING] <wallet-id>
 cmdAddressList
     :: forall t. (DecodeAddress t, EncodeAddress t)
     => Mod CommandFields (IO ())
@@ -584,7 +572,6 @@ cmdAddressList = command "list" $ info (helper <*> cmd) $ mempty
                             Commands - 'version'
 -------------------------------------------------------------------------------}
 
--- | cardano-wallet version
 cmdVersion :: Mod CommandFields (IO ())
 cmdVersion = command "version" $ info cmd $ mempty
     <> progDesc "Show the program's version."