chore(credential-provider-node): fix readme typo #6180
Merged
Conversation
This file contains 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
mxxk
commented
Jun 8, 2024
Comment on lines
+8
to
+10
| This module provides a factory function, `defaultProvider`, that will attempt to | ||
| source AWS credentials from a Node.JS environment. It will attempt to find | ||
| credentials from the following sources (listed in order of precedence): |
There was a problem hiding this comment.
The reformatting here preserves a line character limit of 80, which seems to be the case for this paragraph prior to this change.
|
This is a welcome change. We have a large backlog and it may take a long time to get to individual PRs. |
kuhe
approved these changes
Jun 17, 2024
|
Thank you for clarifying, reviewing, and merging @kuhe! |
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
The README of
credential-provider-nodecurrently 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.mdin 012558d, 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:aws-sdk-js-v3/packages/credential-provider-node/README.md
Lines 65 to 67 in 65eb2e6
This change fixes the inconsistency.
Checklist
@publictag 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.