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(lambda): add missing JSDoc Markdown code block #29348

Merged
merged 4 commits into from
Mar 8, 2024

Conversation

nmussy
Copy link
Contributor

@nmussy nmussy commented Mar 4, 2024

Reason for this change

There is a missing Markdown code block in the EventSourceMapping documentation:

image

Description of changes

Adds missing Markdown code block tags

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team March 4, 2024 05:26
@github-actions github-actions bot added p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Mar 4, 2024
Copy link
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.

@nmussy nmussy changed the title docs(lambda): JSDoc Markdown code block docs(lambda): add missing JSDoc Markdown code block Mar 4, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 4, 2024 05:34

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

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.

Hi @nmussy, putting the code block in means that we will attempt to compile the example with the default rosetta fixture and fail if it does not compile. If you want to contribute this, you'll have to work to get the example to a compiling state. You can test that locally with yarn rosetta:extract

@mergify mergify bot dismissed kaizencc’s stale review March 5, 2024 06:06

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 Mar 5, 2024
@nmussy nmussy requested a review from kaizencc March 5, 2024 07:32
@nmussy
Copy link
Contributor Author

nmussy commented Mar 5, 2024

Hey @kaizencc, sorry about that, I forgot that the docs were also JSII transpiled. Should be good to go now 👍

Copy link
Contributor

@scanlonp scanlonp left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

Copy link
Contributor

mergify bot commented Mar 8, 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).

@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 Mar 8, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit 1f8acc1 into aws:main Mar 8, 2024
12 checks passed
Copy link
Contributor

mergify bot commented Mar 8, 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).

@nmussy nmussy deleted the docs-event-source-mapping branch March 8, 2024 05:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
distinguished-contributor [Pilot] contributed 50+ PRs to the CDK p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants