Skip to content
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

docs(gamelift-alpha): fix typos #32881

Closed
wants to merge 3 commits into from
Closed

Conversation

andyu17
Copy link
Contributor

@andyu17 andyu17 commented Jan 13, 2025

Issue # (if applicable)

None

Reason for this change

Fixed typos in code comments.

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added the p2 label Jan 13, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team January 13, 2025 09:32
@github-actions github-actions bot added the valued-contributor [Pilot] contributed between 6-12 PRs to the CDK label Jan 13, 2025
Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.40%. Comparing base (5f060f4) to head (2300a9f).
Report is 45 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32881      +/-   ##
==========================================
+ Coverage   81.38%   81.40%   +0.02%     
==========================================
  Files         222      223       +1     
  Lines       13695    13727      +32     
  Branches     2412     2411       -1     
==========================================
+ Hits        11145    11175      +30     
- Misses       2271     2274       +3     
+ Partials      279      278       -1     
Flag Coverage Δ
suite.unit 81.40% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 80.74% <ø> (+0.05%) ⬆️
packages/aws-cdk-lib/core 82.10% <ø> (+<0.01%) ⬆️

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 13, 2025
@@ -644,7 +644,7 @@ export abstract class FleetBase extends cdk.Resource implements IFleet {
}

protected warnVpcPeeringAuthorizations(scope: Construct): void {
cdk.Annotations.of(scope).addWarningV2('@aws-cdk/aws-gamelift:fleetAutorizeVpcPeering', [
cdk.Annotations.of(scope).addWarningV2('@aws-cdk/aws-gamelift:fleetAuthorizeVpcPeering', [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As much as this is fixing a typo, changing this value changes observable behavior, and is therefore not okay.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. I have restored the points you pointed out.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 13, 2025
@mergify mergify bot dismissed rix0rrr’s stale review January 13, 2025 12:58

Pull request has been modified.

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 13, 2025
Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

many of these formatting changes in the README i'd prefer not to accept. they're unnecessary, and what we had before was perfectly valid too. the typo fixes are much appreciated though, can we stick to just those changes in this PR? thank you so much for your eagle eyes!

Comment on lines 65 to 73
new gamelift.QueuedMatchmakingConfiguration(
this,
"QueuedMatchmakingConfiguration",
{
matchmakingConfigurationName: "test-queued-config-name",
gameSessionQueues: [queue],
ruleSet: ruleSet,
}
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not a typo and i'm not sure i like the formatting change you've put forth.

Comment on lines 81 to 82
new gamelift.StandaloneMatchmakingConfiguration(this, "StandaloneMatchmaking", {
matchmakingConfigurationName: "test-standalone-config-name",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we are generally ok with (and in fact prefer) ' single quotes

Comment on lines 102 to 106
new gamelift.MatchmakingRuleSet(this, "RuleSet", {
matchmakingRuleSetName: "my-test-ruleset",
content: gamelift.RuleSetContent.fromJsonFile(
path.join(__dirname, "my-ruleset", "ruleset.json")
),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not a fan of these formatting changes

@@ -132,22 +136,23 @@ matchmaking configuration.
declare const matchmakingRuleSet: gamelift.MatchmakingRuleSet;
// Alarm that triggers when the per-second average of not placed matches exceed 10%
const ruleEvaluationRatio = new cloudwatch.MathExpression({
expression: '1 - (ruleEvaluationsPassed / ruleEvaluationsFailed)',
expression: "1 - (ruleEvaluationsPassed / ruleEvaluationsFailed)",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again, we're ok with single quotes

@kaizencc kaizencc changed the title chore(docs): fix typos docs(gamelift-alpha): fix typos Jan 13, 2025
@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 13, 2025
@mergify mergify bot dismissed kaizencc’s stale review January 14, 2025 14:16

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 2300a9f
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 14, 2025
Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We gotta bring the readme back in this PR 😂

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 14, 2025
@andyu17 andyu17 closed this by deleting the head repository Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2 valued-contributor [Pilot] contributed between 6-12 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants