docs(spanner): clarify how to set parameters #428
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
dhui
requested changes
Aug 16, 2020
database/spanner/README.md
Outdated
|
|
||
| | Param | WithInstance Config | Description | | ||
| | Option | WithInstance Config | Description | |
There was a problem hiding this comment.
Leave this as Param since these are URL query params: https://golang.org/pkg/net/url/#Values
There was a problem hiding this comment.
Hi - can do -what was confusing to me about that is that
https://github.com/golang-migrate/migrate/#database-urls uses option=. Would it make sense to change that to param=?
There was a problem hiding this comment.
See if it makes more sense this way. I assumed that the example in the main readme would be the one to follow, but this makes sense, I think?
There was a problem hiding this comment.
Oh yeah, good catch. Let's be consistent and also change the docs in the repo root's README to use params instead of options. Thanks!
wyardley
changed the title
- include param in DSN example - link to README docs on param (option) format - switch to 'parameter' instead of 'option', in the main README, since this is preferred
dhui
approved these changes
Aug 16, 2020
1 task
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.
While this is documented, I think this will make it more clear what the options are called and how to set them (context: #425)