Skip to content

Commit 5bbee04

Browse files
jacobbednarzdetro
andcommitted
update flag descriptions
Co-authored-by: Ivan De Marino <[email protected]>
1 parent b9d3d93 commit 5bbee04

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

internal/cmd/generate.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ func (cmd *generateCmd) Help() string {
3333
func (cmd *generateCmd) Flags() *flag.FlagSet {
3434
fs := flag.NewFlagSet("generate", flag.ExitOnError)
3535
fs.BoolVar(&cmd.flagLegacySidebar, "legacy-sidebar", false, "generate the legacy .erb sidebar file")
36-
fs.StringVar(&cmd.flagProviderName, "provider-name", "", "provider name used for looking up the schema")
37-
fs.StringVar(&cmd.flagRenderedProviderName, "rendered-provider-name", "", "provider name used in generated outputs such as page titles")
38-
fs.StringVar(&cmd.flagRenderedWebsiteDir, "rendered-website-dir", "docs", "directory where the rendered website documentation is generated to")
39-
fs.StringVar(&cmd.flagExamplesDir, "examples-dir", "examples", "directory of examples used in rendered documentation")
40-
fs.StringVar(&cmd.flagWebsiteTmpDir, "website-temp-dir", "", "")
41-
fs.StringVar(&cmd.flagWebsiteSourceDir, "website-source-dir", "templates", "directory of templates that are used for generating the static output")
36+
fs.StringVar(&cmd.flagProviderName, "provider-name", "", "provider name, as used in Terraform configurations")
37+
fs.StringVar(&cmd.flagRenderedProviderName, "rendered-provider-name", "", "provider name, as generated in documentation (ex. page titles, ...)")
38+
fs.StringVar(&cmd.flagRenderedWebsiteDir, "rendered-website-dir", "docs", "output directory")
39+
fs.StringVar(&cmd.flagExamplesDir, "examples-dir", "examples", "examples directory")
40+
fs.StringVar(&cmd.flagWebsiteTmpDir, "website-temp-dir", "", "temporary directory (used during generation)")
41+
fs.StringVar(&cmd.flagWebsiteSourceDir, "website-source-dir", "templates", "templates directory")
4242
fs.StringVar(&cmd.tfVersion, "tf-version", "", "terraform binary version to download")
4343
return fs
4444
}

0 commit comments

Comments
 (0)