Changes to README, instructions for adding as a dependency and using … #100
Conversation
README.md
Outdated
| ``` | ||
|
|
||
| Please note that this package at the time of this writing doesn't use v5 golang client. | ||
| You might have to also do this |
There was a problem hiding this comment.
I'm still unclear on why a separate go get would be required for something that is a transitive dependency of the package you already imported. Also not sure of the relevance of saying that it doesn't use the v5 SDK; an app that imports Relay would not normally have any interaction with Relay's use of the SDK.
There was a problem hiding this comment.
Do you think adding this information will be confusing ?
There was a problem hiding this comment.
Well, I am confused... so I'd like to have a better understanding of what the importance of this information is in your opinion, in case I'm missing something. I realize I didn't put question marks on those two sentences, but I meant them as questions.
There was a problem hiding this comment.
The part about the correct gopkg.in import path for the package is of course important— I wasn't questioning that.
There was a problem hiding this comment.
Maybe I should ask more specifically: did you find that if you did not do a separate go get for the SDK package, something did not work? If so, what?
There was a problem hiding this comment.
In my case it didn't work out of the box without doing the go get. Maybe it is because I was using the launchdarkly client already.
There was a problem hiding this comment.
Well, when I asked "if so, what [did not work]?", I was hoping to get a little more information than "it didn't work". Like, what kind of errors did you see? Again, I'm reluctant to add advice to this readme that I wouldn't be able to explain the reason for to anyone— and if this really is a requirement under some circumstances, knowing more specifically what you saw could be helpful to us in providing support to other developers.
There was a problem hiding this comment.
Removed the client info. I don't remember the error I had, it was something to do with gomod getting confused between v4 and v5 because I was already using the client.
There was a problem hiding this comment.
it was something to do with gomod getting confused between v4 and v5 because I was already using the client
I suspect that this may have meant you were using an incorrect import path somewhere. As far as Go is concerned, gopkg.in/launchdarkly/go-server-sdk.v4 and gopkg.in/launchdarkly/go-server-sdk.v5 are two completely different and unrelated packages.
|
I'm going to reject this PR because at this point it consists only of adding an import path to the sample code in the readme— which I will do on the v5 branch in case we do any more maintenance releases of v5, and it has already been done in the revised docs for the upcoming v6 release— and adding a statement that tells people to use |
This change will not impact any kind of compatibility issues. Nothing to declare here.