service/rds/rdsutils: adding more clarity to rdsutils.BuildAuthToken with an example and cl… #1985
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
xibz
force-pushed
the
doc_fix_token
branch
2 times, most recently
from
2ea3b5d
to
a78f77a
Compare
…eaning up the docs
jasdel
suggested changes
Jun 11, 2018
service/rds/rdsutils/example_test.go
Outdated
| // that to build the auth token. | ||
| // Usage: | ||
| // ./main -user "iamuser" -dbname "foo" -region "us-west-2" -rolearn "arn" -endpoint "dbendpoint" -port 3306 | ||
| func ExampleRDSUtils_ConnectViaAssumeRole() { |
There was a problem hiding this comment.
This example naming is causing the tests to fail. To have the example paired with the godocs this should be named. ExampleBuildAuthToken
xibz
force-pushed
the
doc_fix_token
branch
5 times, most recently
from
34c07dd
to
2d9ea43
Compare
jasdel
approved these changes
Jun 11, 2018
xibz
force-pushed
the
doc_fix_token
branch
3 times, most recently
from
92bf47e
to
2cf3981
Compare
Merged
diehlaws
added
feature-request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.