docs icon indicating copy to clipboard operation
docs copied to clipboard

Docs for property including subsequent bullet as part of its docs

Open justinvp opened this issue 6 years ago • 0 comments

We've seen at least one case where a nested output property is including the subsequent bullet as part of its docs.

https://github.com/pulumi/pulumi-aws/blob/ed4659e42c6700e442c578be9f6fa1537f16a801/sdk/nodejs/types/output.ts#L600-L635

export interface TargetGroupHealthCheck { 
   /** 
    * Indicates whether  health checks are enabled. Defaults to true. 
    */ 
   enabled?: boolean; 
   /** 
    * The number of consecutive health checks successes required before considering an unhealthy target healthy. Defaults to 3. 
    */ 
   healthyThreshold?: number; 
   /** 
    * The approximate amount of time, in seconds, between health checks of an individual target. Minimum value 5 seconds, Maximum value 300 seconds. For `lambda` target groups, it needs to be greater as the `timeout` of the underlying `lambda`. Default 30 seconds. 
    */ 
   interval?: number; 
   matcher: string; 
   /** 
    * The destination for the health check request. Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP). 
    */ 
   path: string; 
   /** 
    * The port to use to connect with the target. Valid values are either ports 1-65536, or `traffic-port`. Defaults to `traffic-port`. 
    */ 
   port?: string; 
   /** 
    * The protocol to use to connect with the target. Defaults to `HTTP`. Not applicable when `targetType` is `lambda`. 
    */ 
   protocol?: string; 
   /** 
    * The amount of time, in seconds, during which no response means a failed health check. For Application Load Balancers, the range is 2 to 120 seconds, and the default is 5 seconds for the `instance` target type and 30 seconds for the `lambda` target type. For Network Load Balancers, you cannot set a custom value, and the default is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks. 
    */ 
   timeout: number; 
   /** 
    * The number of consecutive health check failures required before considering the target unhealthy . For Network Load Balancers, this value must be the same as the `healthyThreshold`. Defaults to 3. 
    * * `matcher` (Required for HTTP/HTTPS ALB) The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299"). Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP). 
    */ 
   unhealthyThreshold?: number; 
} 

Notice how matcher does not have a doc comment, but unhealthyThreshold includes:

 /** 
  * The number of consecutive health check failures required before considering the target unhealthy . For Network Load Balancers, this value must be the same as the `healthyThreshold`. Defaults to 3. 
  * * `matcher` (Required for HTTP/HTTPS ALB) The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299"). Applies to Application Load Balancers only (HTTP/HTTPS), not Network Load Balancers (TCP). 
  */ 

https://github.com/pulumi/terraform-provider-aws/blob/pulumi-master/website/docs/r/lb_target_group.html.markdown

justinvp avatar Aug 27 '19 00:08 justinvp