chore(readme): update default description #36307
Conversation
|
||||||||||||||
|
||||||||||||||
mazyu36
left a comment
There was a problem hiding this comment.
Thanks for the contribution. I've left a few minor comments.
| * This field specifies where in the request the API key should be placed. | ||
| * | ||
| * @default - HEADER | ||
| * @default HEADER |
There was a problem hiding this comment.
| * @default HEADER | |
| * @default - HEADER |
Since HEADER is not a value, I thought the version before the modification might be better.
| /** | ||
| * The name of the Fargate profile. | ||
| * @default - generated | ||
| * @default generated |
There was a problem hiding this comment.
| * @default generated | |
| * @default - generated |
Since this is not a value, I thought the version before the modification might be better.
| * If the game session does not become active before the timeout, it is ended and the game session status is changed to `TERMINATED`. | ||
| * | ||
| * @default by default game session activation timeout is 300 seconds | ||
| * @default - by default game session activation timeout is 300 seconds |
There was a problem hiding this comment.
| * @default - by default game session activation timeout is 300 seconds | |
| * @default Duration.seconds(300) |
| * @see https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html | ||
| * | ||
| * @default - 4.0.2 | ||
| * @default 4.0.2 |
There was a problem hiding this comment.
| * @default 4.0.2 | |
| * @default '4.0.2' |
Since it's a string, I thought it would be better to have single quotation marks.
| * The capacity type of the nodegroup. | ||
| * | ||
| * @default - ON_DEMAND | ||
| * @default ON_DEMAND |
There was a problem hiding this comment.
| * @default ON_DEMAND | |
| * @default CapacityType.ON_DEMAND |
| * | ||
| * @see https://docs.aws.amazon.com/eks/latest/userguide/node-health.html#node-auto-repair | ||
| * @default - disabled | ||
| * @default disabled |
There was a problem hiding this comment.
| * @default disabled | |
| * @default false |
Is this referring to false? If you're removing the hyphen, I think it would be better to make it a boolean value.
| * then port 22 on the worker nodes is opened to the internet (0.0.0.0/0) | ||
| * | ||
| * @default - disabled | ||
| * @default disabled |
There was a problem hiding this comment.
| * @default disabled | |
| * @default - disabled |
Since this is not a value, I think it would be better to keep the hyphen.
| * The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default. | ||
| * | ||
| * @default - desiredSize | ||
| * @default desiredSize |
There was a problem hiding this comment.
| * @default desiredSize | |
| * @default - same as desiredSize property |
This is an original issue, but I think it would be better to note that it's automatically set to the same value as other properties.
|
@mazyu36 Thank you for your review! I'll address your comments later. |
Co-authored-by: Yuki Matsuda <[email protected]>
Issue # (if applicable)
None
Reason for this change
Default description is not correctly styled.
Description of changes
Update default description
Describe any new or updated permissions being added
None
Description of how you validated changes
None
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license