-
Notifications
You must be signed in to change notification settings - Fork 245
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
sphinx: Default values aren't shown in docs #298
Comments
And the (abstract), though technically true, doesn't really help either
… On 7 Nov 2018, at 19:55, Clare Liguori ***@***.***> wrote:
I'm noticing that the ***@***.***" 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:
***@***.***/aws-ecs.LoadBalancedFargateServiceProps.containerPort
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub, or mute the thread.
|
eladb
changed the title
Default values aren't shown in docs
sphinx: Default values aren't shown in docs
Nov 8, 2018
eladb
pushed a commit
that referenced
this issue
Nov 8, 2018
Fixes #301: reject non-optional arguments after optional arguments Fixes #298: show default values for optional properties Fixes #302: omit "abstract" from interface properties (they are by definition abstract) Fixes #300: indicate optionals with "optional" instead of "or undefined" Fixes #299: render multiple jsdoc lines as multiple lines in sphinx
eladb
pushed a commit
that referenced
this issue
Nov 8, 2018
Fixes #301: reject non-optional arguments after optional arguments Fixes #298: show default values for optional properties Fixes #302: omit "abstract" from interface properties (they are by definition abstract) Fixes #300: indicate optionals with "optional" instead of "or undefined" Fixes #299: render multiple jsdoc lines as multiple lines in sphinx
Should be fixed in the latest release |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
The text was updated successfully, but these errors were encountered: