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(clients): add missing await for client.operationName call #2243

Merged
merged 3 commits into from
Apr 14, 2021

Conversation

trivikr
Copy link
Member

@trivikr trivikr commented Apr 13, 2021

Issue

Fixes: #2231

Description

Adds missing await for client.operationName call in README

Testing

Verified that missing await is added in README


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@aws-sdk-js-automation
Copy link

AWS CodeBuild CI Report

  • CodeBuild project: sdk-staging-test
  • Commit ID: 62b375d
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@codecov-io
Copy link

codecov-io commented Apr 13, 2021

Codecov Report

❗ No coverage uploaded for pull request base (main@d6a67d7). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2243   +/-   ##
=======================================
  Coverage        ?   61.83%           
=======================================
  Files           ?      453           
  Lines           ?    23289           
  Branches        ?     5519           
=======================================
  Hits            ?    14401           
  Misses          ?     8888           
  Partials        ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d6a67d7...62b375d. Read the comment docs.

@pratikpc
Copy link
Contributor

@trivikr it would be nice if we could have better examples too

For example, for AWS SES, I had to go to https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/ses-examples-sending-email.html to find out how to send EMails which I think should be the focus of AWS SES docs

@trivikr
Copy link
Member Author

trivikr commented Apr 13, 2021

it would be nice if we could have better examples too

For example, for AWS SES, I had to go to docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/ses-examples-sending-email.html to find out how to send EMails which I think should be the focus of AWS SES docs

The current README.md has auto generated examples.
We're working on improved API Reference story, where specific examples related to service would be added.

@trivikr trivikr merged commit 5fe8ed6 into aws:main Apr 14, 2021
@trivikr trivikr deleted the add-missing-await-in-readme branch April 14, 2021 01:53
@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs(clients) async/await example does not use async await
5 participants