Skip to content

Commit

Permalink
fix: Update CLI flags docs (#811)
Browse files Browse the repository at this point in the history
--generatedTime was documented as true by default, although immediately
after we stated that it was false by default.

Also capitalized the --exclude docs, and updated README.md's output for
consistency.
  • Loading branch information
colega authored Oct 19, 2020
1 parent 6937d1c commit eeae42f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,16 @@ USAGE:
OPTIONS:
--generalInfo value, -g value Go file path in which 'swagger general API Info' is written (default: "main.go")
--dir value, -d value Directory you want to parse (default: "./")
--exclude value Exclude directories and files, comma separated
--exclude value Exclude directories and files when searching, comma separated
--propertyStrategy value, -p value Property Naming Strategy like snakecase,camelcase,pascalcase (default: "camelcase")
--output value, -o value Output directory for all the generated files(swagger.json, swagger.yaml and doc.go) (default: "./docs")
--parseVendor Parse go files in 'vendor' folder, disabled by default (default: false)
--parseDependency Parse go files in outside dependency folder, disabled by default (default: false)
--markdownFiles value, --md value Parse folder containing markdown files to use as description, disabled by default
--codeExampleFiles value, --cef value Parse folder containing code example files to use for the x-codeSamples extension, disabled by default
--parseInternal Parse go files in internal packages, disabled by default (default: false)
--generatedTime Generate timestamp at the top of docs.go, true by default (default: false)
--parseDepth Dependency parse depth (default: 100)
--generatedTime Generate timestamp at the top of docs.go, disabled by default (default: false)
--parseDepth value Dependency parse depth (default: 100)
--help, -h show help (default: false)
```

Expand Down
4 changes: 2 additions & 2 deletions cmd/swag/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ var initFlags = []cli.Flag{
},
&cli.StringFlag{
Name: excludeFlag,
Usage: "exclude directories and files when searching, comma separated",
Usage: "Exclude directories and files when searching, comma separated",
},
&cli.StringFlag{
Name: propertyStrategyFlag,
Expand Down Expand Up @@ -80,7 +80,7 @@ var initFlags = []cli.Flag{
},
&cli.BoolFlag{
Name: generatedTimeFlag,
Usage: "Generate timestamp at the top of docs.go, true by default",
Usage: "Generate timestamp at the top of docs.go, disabled by default",
},
&cli.IntFlag{
Name: parseDepthFlag,
Expand Down

0 comments on commit eeae42f

Please sign in to comment.