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

Clarify profile file parsing docs #733

Closed
rcoh opened this issue Sep 30, 2021 · 0 comments · Fixed by #905
Closed

Clarify profile file parsing docs #733

rcoh opened this issue Sep 30, 2021 · 0 comments · Fixed by #905
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@rcoh
Copy link
Collaborator

rcoh commented Sep 30, 2021

Many docs refer people to https://awslabs.github.io/aws-sdk-rust/aws_config/profile/fn.load.html because this is where we've documented all of the profile loading logic.

However, this is confusing because we don't actually expect people to use this function, just use the docs there to explain how parsing works.

These docs should be hoisted somewhere that is easier to find.

So far, 2 customers have run into this specific issue so it's probably worth getting done sooner rather than later.

@rcoh rcoh added the documentation Improvements or additions to documentation label Sep 30, 2021
@rcoh rcoh added this to the Dev Preview milestone Sep 30, 2021
@rcoh rcoh self-assigned this Nov 19, 2021
@rcoh rcoh closed this as completed in #905 Nov 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant