docs(client): make example in README compile #604
Conversation
There was a problem hiding this comment.
Thanks for the contribution! I had a question and potential suggestion.
Also, in order to merge this change, the CLA must be signed using https://cla.shopify.com/ and then comment on this PR with "I have signed the CLA!" to re-run the checks.
| proxies, err = toxiClient.Proxies() | ||
| if err != nil { | ||
| panic(err) | ||
| } |
There was a problem hiding this comment.
This addition seems incorrect as proxies is assigned on line 108 as a result of the toxiClient.Populate call.
If this is meant as another example, similar to the example on line 122, I would be okay with this remaining but the indentation should be fixed, it should be commented out, and a comment added explaining what it does if its uncommented.
There was a problem hiding this comment.
Populate returns an array, not a map: https://pkg.go.dev/github.com/shopify/toxiproxy/client#Client.Populate
Which is why this program was not compiling. I just looked through the API quickly and found Proxies() which returns a map instead. I'm assuming the API changed at some point. Not sure if this is correct semantically though... spent like 5 mins on this last night.
|
I have signed the CLA! |
|
Thank you for the PR and bringing this to our attention. Actually fixing this example to compile with the current API required some more involved changes. I've made #607 which does all the updates. I'm going to close this PR in favour of that one. |
No description provided.