Skip to content

docs: fix improper JSDoc formatting#31820

Merged
mergify[bot] merged 2 commits intoaws:mainfrom
badmintoncryer:formatJsdoc
Oct 23, 2024
Merged

docs: fix improper JSDoc formatting#31820
mergify[bot] merged 2 commits intoaws:mainfrom
badmintoncryer:formatJsdoc

Conversation

@badmintoncryer
Copy link
Copy Markdown
Contributor

@badmintoncryer badmintoncryer commented Oct 19, 2024

Issue # (if applicable)

None

Reason for this change

There are some improper JSDoc formatting.

Description of changes

I have corrected multiple instances of improper JSDoc formatting.

/**
-   * description
-   * 
-   * @default - xxx
-   */
+ * description
+ * 
+ * @default - xxx
+ */

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

@github-actions github-actions bot added p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Oct 19, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team October 19, 2024 23:16
@badmintoncryer badmintoncryer changed the title chore(): format jsdoc docs: fix improper JSDoc formatting Oct 19, 2024
aws-cdk-automation
aws-cdk-automation previously requested changes Oct 19, 2024
View reviewed changes
Copy link
Copy Markdown
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Oct 19, 2024
@badmintoncryer
Copy link
Copy Markdown
Contributor Author

badmintoncryer commented Oct 19, 2024

Exemption request
As this is a JSDoc-only fix, there is no effect on the production code.

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Oct 19, 2024
@badmintoncryer badmintoncryer marked this pull request as ready for review October 19, 2024 23:22
@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 Oct 19, 2024
@sumupitchayan sumupitchayan added pr-linter/exempt-test The PR linter will not require test changes and removed pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. pr/needs-cli-test-run This PR needs CLI tests run against it. labels Oct 22, 2024
sumupitchayan
sumupitchayan previously approved these changes Oct 22, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@sumupitchayan sumupitchayan left a comment

Choose a reason for hiding this comment

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

LGTM, not sure how these comments got past the linter in the first place

@aws-cdk-automation aws-cdk-automation added pr/needs-cli-test-run This PR needs CLI tests run against it. and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Oct 22, 2024
@sumupitchayan sumupitchayan added pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested and removed pr/needs-cli-test-run This PR needs CLI tests run against it. labels Oct 22, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review October 22, 2024 20:48

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 22, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@sumupitchayan
Copy link
Copy Markdown
Contributor

sumupitchayan commented Oct 22, 2024

@Mergifyio update

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 22, 2024

update

❌ Mergify doesn't have permission to update

Details

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/request-cli-integ-test.yml without workflows permission

@badmintoncryer
Copy link
Copy Markdown
Contributor Author

badmintoncryer commented Oct 23, 2024

@mergify update

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 23, 2024

update

❌ Mergify doesn't have permission to update

Details

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/request-cli-integ-test.yml without workflows permission

@mergify mergify bot dismissed sumupitchayan’s stale review October 23, 2024 12:51

Pull request has been modified.

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

aws-cdk-automation commented Oct 23, 2024

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: f9d9bfa
  • 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 Oct 23, 2024
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 23, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 1e73ac5 into aws:main Oct 23, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 23, 2024

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 23, 2024
@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 Oct 23, 2024
@badmintoncryer badmintoncryer deleted the formatJsdoc branch October 23, 2024 22:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@aws-cdk-automation aws-cdk-automation aws-cdk-automation left review comments

+1 more reviewer

@sumupitchayan sumupitchayan sumupitchayan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

distinguished-contributor [Pilot] contributed 50+ PRs to the CDK p2 pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested pr-linter/exempt-test The PR linter will not require test changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@badmintoncryer @sumupitchayan @aws-cdk-automation