docs: improve Lambda import names#22014
Merged
mergify[bot] merged 1 commit intoaws:mainfrom Sep 13, 2022
Merged
Conversation
In the `aws-lambda-nodejs`, `aws-lambda-python`, and `aws-lambda-go` package `README`s, the code examples use `lambda` as the name to import the package. This makes the code examples confusing because `rosetta/default.ts-fixture` masks the `import` statement from readers and may confuse them as to why their `lambda` import doesn't work when they use `lambda.NodejsFunction` (or similar). The imports are changed to `nodejs`, `python`, and `go`. While the last (`go`) is in fact a keyword in its own language, so too is `lambda` in Python. This matches the pattern used by other packages' examples (`aws-route53-patterns` for example uses `patterns` as the name for its import in docs). This change should make the docs more clear to new users, who likely started using Lambda using `lambda.Function` and already have a `lambda` import that won't do what they want.
|
|
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
corymhall
approved these changes
Sep 13, 2022
Contributor
|
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). |
mackalex
pushed a commit
to wanjacki/aws-cdk
that referenced
this pull request
Sep 15, 2022
In the `aws-lambda-nodejs`, `aws-lambda-python`, and `aws-lambda-go` package `README`s, the code examples use `lambda` as the name to import the package. This makes the code examples confusing because `rosetta/default.ts-fixture` masks the `import` statement from readers and may confuse them as to why their `lambda` import doesn't work when they use `lambda.NodejsFunction` (or similar). The imports are changed to `nodejs`, `python`, and `go`. While the last (`go`) is in fact a keyword in its own language, so too is `lambda` in Python. This matches the pattern used by other packages' examples (`aws-route53-patterns` for example uses `patterns` as the name for its import in docs). This change should make the docs more clear to new users, who likely started using Lambda using `lambda.Function` and already have a `lambda` import that won't do what they want. Closes aws#22003 ---- ### All Submissions: * [X] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the
aws-lambda-nodejs,aws-lambda-python, andaws-lambda-gopackage
READMEs, the code examples uselambdaas the name to importthe package. This makes the code examples confusing because
rosetta/default.ts-fixturemasks theimportstatement from readersand may confuse them as to why their
lambdaimport doesn't work whenthey use
lambda.NodejsFunction(or similar). The imports are changedto
nodejs,python, andgo. While the last (go) is in fact akeyword in its own language, so too is
lambdain Python. This matchesthe pattern used by other packages' examples (
aws-route53-patternsforexample uses
patternsas the name for its import in docs).This change should make the docs more clear to new users, who likely
started using Lambda using
lambda.Functionand already have alambdaimport that won't do what they want.
Closes #22003
All Submissions:
Adding new Unconventional Dependencies:
New Features
yarn integto deploy the infrastructure and generate the snapshot (i.e.yarn integwithout--dry-run)?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license