Skip to content

Commit aae9ce9

Browse files
committed
Clarify code comments
1 parent 5521b47 commit aae9ce9

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

registry_module.go

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -345,14 +345,12 @@ type RegistryModuleCreateWithVCSConnectionOptions struct {
345345
// https://jsonapi.org/format/#crud-creating
346346
Type string `jsonapi:"primary,registry-modules"`
347347

348-
// Optional: The name of the module. If not provided, will be inferred from the VCS repository identifier.
349-
// This is particularly useful for monorepos with source_directory where the repository name
350-
// doesn't follow the terraform-<provider>-<name> convention.
348+
// Optional: The Name of the Module. If not provided, will be inferred from the VCS repository identifier.
349+
// Required for monorepos with source_directory where the repository name doesn't follow the terraform-<provider>-<name> convention.
351350
Name *string `jsonapi:"attr,name,omitempty"`
352351

353-
// Optional: The provider name. If not provided, will be inferred from the VCS repository identifier.
354-
// This is particularly useful for monorepos with source_directory where the repository name
355-
// doesn't follow the terraform-<provider>-<name> convention.
352+
// Optional: The Name of the Provider. If not provided, will be inferred from the VCS repository identifier.
353+
// Required for monorepos with source_directory where the repository name doesn't follow the terraform-<provider>-<name> convention.
356354
Provider *string `jsonapi:"attr,provider,omitempty"`
357355

358356
// Required: VCS repository information

0 commit comments

Comments
 (0)