Skip to content

Commit 05f6b44

Browse files
committed
Docs update
1 parent 7d1612f commit 05f6b44

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

extras/lbf-haskell.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ lbg-haskell:
55
{
66
# Nixpkgs
77
pkgs
8-
, # Source that are passed to `lbf` as the `--import-path` flag and used to find `files`.
8+
, # Source that is passed to `lbf` as the `--import-path` flag and used to find `files`.
99
# Examples: src = ./api
1010
src
1111
, # Additional sources that are passed to `lbf` as the `--import-path` flag.

extras/lbf-purescript.nix

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ lbg-purescript:
55
{
66
# Nixpkgs
77
pkgs
8-
, # Source that are passed to `lbf` as the `--import-path` flag and used to find `files`.
9-
# Examples: src = [ ./api ]
8+
, # Source that is passed to `lbf` as the `--import-path` flag and used to find `files`.
9+
# Examples: src = ./api
1010
src
1111
, # Additional sources that are passed to `lbf` as the `--import-path` flag.
1212
# Examples: imports = [ lbf-prelude ]

lambda-buffers-frontend/app/Main.hs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,15 @@ buildOptsP =
7070
( strOption
7171
( long "gen-class"
7272
<> metavar "CLASS"
73-
<> help "Class to code generate implementations for (if empty only the type definitions will be printed)"
73+
<> help "Class to code generate implementations for (if empty only the type definitions will be printed). For example: --gen-class Prelude.Eq --gen-class Prelude.Json"
7474
<> showDefault
7575
)
7676
)
7777
<*> many
7878
( strOption
7979
( long "gen-opt"
8080
<> metavar "ARGUMENT"
81-
<> help "Additional options to provide to the Codegen module"
81+
<> help "Additional options to provide to the Codegen module. For example: --gen-opt=--config --gen-opt=haskell.json"
8282
)
8383
)
8484
<*> flag
@@ -107,14 +107,14 @@ formatOptsP =
107107
( long "file"
108108
<> short 'f'
109109
<> metavar "FILEPATH"
110-
<> help "LambdaBuffers file to format"
110+
<> help ".lbf schema to format"
111111
)
112112
<*> flag
113113
False
114114
True
115115
( long "inplace"
116116
<> short 'i'
117-
<> help "Replace the file content with the formatted version"
117+
<> help "Replace the .lbf schema content with the formatted version"
118118
<> showDefault
119119
)
120120

@@ -123,10 +123,10 @@ commandP =
123123
subparser $
124124
command
125125
"build"
126-
(info (Build <$> buildOptsP <* helper) (progDesc "Build LambdaBuffers .lbf schemas"))
126+
(info (Build <$> (helper *> buildOptsP)) (progDesc "Build LambdaBuffers .lbf schemas"))
127127
<> command
128128
"format"
129-
(info (Format <$> formatOptsP <* helper) (progDesc "Format a LambdaBuffers Module (.lbf)"))
129+
(info (Format <$> (helper *> formatOptsP)) (progDesc "Format a LambdaBuffers Module (.lbf)"))
130130

131131
parserInfo :: ParserInfo Command
132132
parserInfo = info (commandP <**> helper) (fullDesc <> progDesc "LambdaBuffers Frontend command-line interface tool")

0 commit comments

Comments
 (0)