search

ninenines / gun

HTTP/1.1, HTTP/2, Websocket client (and more) for Erlang/OTP.
ISC License
898 stars 231 forks source link

Update `ws_opts` type #172

Closed michalwski closed 6 years ago

michalwski commented 6 years ago

This PR adds the optional protocols key to ws_opts type and updates relevant parts of the documentation.

It also fixes #171

essen commented 6 years ago

I need to update the CI rules to make the tests run. I'll get back to you.

You forgot to detail the protocols option in the manual, by the way. I'm not sure I want to document the module interface yet, at least not until there are test cases. So in the description of the option you should say that the module should be gun_ws_h for now.

We'll probably need test cases for this module but there's no test suite yet so that can wait (I got a custom protocol module at customer so it's not entirely untested).

michalwski commented 6 years ago

So in the description of the option you should say that the module should be gun_ws_h for now.

Do you want this said in both the guide and the manual or just the manual?

essen commented 6 years ago

Both. Precisely the guide should not have that last 3 lines paragraph but rather say the module must be gun_ws_h.

michalwski commented 6 years ago

All right, updated.

essen commented 6 years ago

Your tests passed. I'll probably look on Monday, that's when I'll finish up the 1.3 release.

essen commented 6 years ago

Merged locally with tweaks, thanks!

michalwski commented 6 years ago

Thanks!