Skip to content

Commit 2e51bca

Browse files
committed
chore: fix docs
1 parent 24b3aeb commit 2e51bca

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ After, you can use the `deserialize_response/3` function of the messages API, pa
154154

155155
## SASL
156156

157-
SASL is handled by the `KlifeProtocol.Socket` module and client libraries can pass use it in 2 ways:
157+
SASL is handled by the `KlifeProtocol.Socket` module and client libraries can use it in 2 ways:
158158

159159
- Passing SASL options to `connect/3` function when creationg a new socket
160160
- Passing an already open socket and SASL opts to `authenticate/3` function

lib/klife_protocol/socket.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ defmodule KlifeProtocol.Socket do
77
- backend: `:gen_tcp` or `:ssl` (defaults to `:gen_tcp`)
88
- sasl_opts: optional. sasl only. Is a keyword list containing:
99
- mechanism: sasl mechanism string (eg. "PLAIN"),
10-
- sasl_auth_vsn: api version number to use for SaslAuthenticate messages,
11-
- sasl_handshake_vsn: api version number to use for SaslHandshake messages,
10+
- auth_vsn: api version number to use for SaslAuthenticate messages,
11+
- handshake_vsn: api version number to use for SaslHandshake messages,
1212
- mechanism_opts: mechanism specific keywordlist
1313
- any other option will be forwarded to the backend module `connect/3` function
1414
"""

0 commit comments

Comments
 (0)