Adds additional comments around optional environment configuration fo…

…r commands

cli/azd/cmd/actions/action_descriptor.go

@@ -150,6 +150,8 @@ type CommandGroupOptions struct {
 
 // EnvironmentOptions contains options for the environment flag and initialization
 type EnvironmentOptions struct {
+	// Optional should be set to true when an azd environment is optional within an azd command.
+	// Well known use cases for this are for `azd init` and `azd show`
 	Optional bool
 }
 

cli/azd/cmd/root.go

@@ -343,6 +343,9 @@ func NewRootCmd(
 			return !descriptor.Options.DisableTelemetry
 		}).
 		UseMiddlewareWhen("environment", middleware.NewEnvironmentMiddleware, func(descriptor *actions.ActionDescriptor) bool {
+			// The environment middleware will only be applied to commands that have the environment flag
+			// AND
+			// on commands where an environment is always required
 			_, err := descriptor.Options.Command.Flags().GetString(internal.EnvironmentNameFlagName)
 			return err == nil && !descriptor.Options.Environment.Optional
 		})