Adjust provider-dir flag description

hashicorp · Jun 6, 2023 · 97afc59 · 97afc59
1 parent fc11e08
commit 97afc59
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -39,15 +39,15 @@ $ tfplugindocs generate --help
 
 Usage: tfplugindocs generate [<args>]
 
-    --examples-dir <ARG>             examples directory based on provider-dir                                  (default: "examples")
-    --ignore-deprecated <ARG>        don't generate documentation for deprecated resources and data-sources    (default: "false")
-    --provider-dir <ARG>             relative or absolute directory of provider code
-    --provider-name <ARG>            provider name, as used in Terraform configurations
-    --rendered-provider-name <ARG>   provider name, as generated in documentation (ex. page titles, ...)
-    --rendered-website-dir <ARG>     output directory based on provider-dir                                    (default: "docs")
-    --tf-version <ARG>               terraform binary version to download
-    --website-source-dir <ARG>       templates directory based on provider-dir                                 (default: "templates")
-    --website-temp-dir <ARG>         temporary directory (used during generation)
+    --examples-dir <ARG>             examples directory based on provider-dir                                                                                           (default: "examples")
+    --ignore-deprecated <ARG>        don't generate documentation for deprecated resources and data-sources                                                             (default: "false")
+    --provider-dir <ARG>             relative or absolute path to the root provider code directory when running the command outside the root provider code directory  
+    --provider-name <ARG>            provider name, as used in Terraform configurations                                                                               
+    --rendered-provider-name <ARG>   provider name, as generated in documentation (ex. page titles, ...)                                                              
+    --rendered-website-dir <ARG>     output directory based on provider-dir                                                                                             (default: "docs")
+    --tf-version <ARG>               terraform binary version to download                                                                                             
+    --website-source-dir <ARG>       templates directory based on provider-dir                                                                                          (default: "templates")
+    --website-temp-dir <ARG>         temporary directory (used during generation)  
 ```
 
 `validate` command:

diff --git a/internal/cmd/generate.go b/internal/cmd/generate.go
@@ -72,7 +72,7 @@ func (cmd *generateCmd) Help() string {
 func (cmd *generateCmd) Flags() *flag.FlagSet {
 	fs := flag.NewFlagSet("generate", flag.ExitOnError)
 	fs.StringVar(&cmd.flagProviderName, "provider-name", "", "provider name, as used in Terraform configurations")
-	fs.StringVar(&cmd.flagProviderDir, "provider-dir", "", "relative or absolute directory of provider code")
+	fs.StringVar(&cmd.flagProviderDir, "provider-dir", "", "relative or absolute path to the root provider code directory when running the command outside the root provider code directory")
 	fs.StringVar(&cmd.flagRenderedProviderName, "rendered-provider-name", "", "provider name, as generated in documentation (ex. page titles, ...)")
 	fs.StringVar(&cmd.flagRenderedWebsiteDir, "rendered-website-dir", "docs", "output directory based on provider-dir")
 	fs.StringVar(&cmd.flagExamplesDir, "examples-dir", "examples", "examples directory based on provider-dir")