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

chore(lambda-event-sources): fix typo in readme #9959

Merged

Conversation

simonireilly
Copy link
Contributor

This is a fix for the README in the Kinesis event source example. This removes the undeclared variable queue from the example and replaces it with the stream.

This is a simple typo pointing to a variable that was not declared in the example for Kinesis.

The motivation for this change is:

  • To ensure developers have accurate documentation.
  • To ensure developers have a good experience when attempting to understand the features of the CDK from the documentation.

There is a convention in the README's to refer to variables outside the scope of the example e.g.

myFunction.addEventSource( //etc

Where myFunction is not declared in the scope of the example. This fix prevents the assumption that a queue resource has also been created outside the scope of the example.


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

This is a fix for the README in the Kinesis event source example. This removes the undeclared variable `queue` from the example and replaces it with the `stream`.
shivlaks
shivlaks previously approved these changes Aug 28, 2020
@SomayaB SomayaB changed the title chore( aws-lambda-event-sources): fix typo in readme chore(aws-lambda-event-sources): fix typo in readme Aug 31, 2020
@gitpod-io
Copy link

gitpod-io bot commented Oct 15, 2020

@mergify mergify bot dismissed shivlaks’s stale review October 15, 2020 17:37

Pull request has been modified.

@nija-at nija-at changed the title chore(aws-lambda-event-sources): fix typo in readme chore(lambda-event-sources): fix typo in readme Oct 16, 2020
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 5007a67
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify
Copy link
Contributor

mergify bot commented Oct 16, 2020

Thank you for contributing! Your pull request will be updated from master 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 3839796 into aws:master Oct 16, 2020
@simonireilly simonireilly deleted the update-aws-lambda-event-sources-readme branch October 16, 2020 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants