Skip to content

sphinx: Default values aren't shown in docs #298

@clareliguori

Description

@clareliguori

I'm noticing that the "@default" flag in the code comments is not translating into a default value shown in the docs. From the docs, it reads as though there is no default value, which is confusing.

For example, default value for containerPort (80) in LoadBalancedFargateService:

https://github.com/awslabs/aws-cdk/blob/master/packages/%40aws-cdk/aws-ecs/lib/load-balanced-fargate-service.ts#L62

Is not shown in the docs:

https://awslabs.github.io/aws-cdk/refs/_aws-cdk_aws-ecs.html#@aws-cdk/aws-ecs.LoadBalancedFargateServiceProps.containerPort

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions