Closed mxxk closed 1 week ago
This is a very trivial PR which fixes a confusing typo in the README of a package, but it sat for 5 days without any activity. @jgrigg @kuhe @siddsriv @trivikr are you the right people to ping to get the ball rolling here?
This is a welcome change. We have a large backlog and it may take a long time to get to individual PRs.
Thank you for clarifying, reviewing, and merging @kuhe!
Description
The README of
credential-provider-node
currently refers tofromEnv
(which does not exist in the package). This change fixes README to instead refer todefaultProvider
.Testing
N/A
Additional context
Since the initial introduction of
packages/credential-provider-node/README.md
in https://github.com/aws/aws-sdk-js-v3/commit/012558d471faf3ef80dd83628f81ba065c286e8a, the README referred tofromEnv
, which did not exist then, nor does it exist now.Later sections of README refer to the same factory function as
defaultProvider
:https://github.com/aws/aws-sdk-js-v3/blob/65eb2e631383a82deb009bcb0983ae114c0c7b26/packages/credential-provider-node/README.md?plain=1#L65-L67
This change fixes the inconsistency.
Checklist
@public
tag and enable doc generation on the package?By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.