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.

Sign up for GitHub

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

Jump to bottom

aws-lambda-nodejs: incomprehensible documentation for bundleAwsSDK #31789

Closed
wimlewis-amazon opened this issue Oct 16, 2024 · 3 comments · Fixed by #31839
Closed

aws-lambda-nodejs: incomprehensible documentation for bundleAwsSDK #31789

wimlewis-amazon opened this issue Oct 16, 2024 · 3 comments · Fixed by #31839
Labels
@aws-cdk/aws-lambda-nodejs documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@wimlewis-amazon
Copy link

Describe the issue

The sentence starting "This will be essentially exclude sdk..." is difficult to extract any meaning from. I can guess kinda what it means by context and from being pretty familiar with this module, but it would be nice if it were grammatical and said something.

Links

aws-cdk/packages/aws-cdk-lib/aws-lambda-nodejs/README.md

Line 178 in 799b541

Includes AWS SDK in the bundle asset by setting `bundleAwsSDK` to `true`. This will be essentially exclude sdk from the external

@wimlewis-amazon wimlewis-amazon added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Oct 16, 2024
@khushail khushail added investigating This issue is being investigated and/or work is in progress to resolve the issue. p2 and removed needs-triage This issue or PR still needs to be triaged. labels Oct 17, 2024
@khushail
Copy link
Contributor

khushail commented Oct 17, 2024 •
edited
Loading

@wimlewis-amazon , thanks for highlighting the grammatical mistake in docs. it should be corrected to draw meaningful conclusion.

@khushail khushail added effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Oct 17, 2024
@khushail khushail mentioned this issue Oct 21, 2024
Merged
1 task
@mergify mergify bot closed this as completed in #31839 Oct 22, 2024
@mergify mergify bot closed this as completed in f1e2f3b Oct 22, 2024
@github-actions GitHub Actions
Copy link

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.

1 similar comment
@github-actions GitHub Actions
Copy link

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 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
@aws-cdk/aws-lambda-nodejs documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(lambda-nodejs): grammatical correction in statement reg bundleAwsSDK aws/aws-cdk
2 participants
@wimlewis-amazon @khushail