Skip to content

Commit

Permalink
chore: fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oliveigah committed Oct 14, 2024
1 parent 24b3aeb commit 2e51bca
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ After, you can use the `deserialize_response/3` function of the messages API, pa

## SASL

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

- Passing SASL options to `connect/3` function when creationg a new socket
- Passing an already open socket and SASL opts to `authenticate/3` function
Expand Down
4 changes: 2 additions & 2 deletions lib/klife_protocol/socket.ex
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ defmodule KlifeProtocol.Socket do
- backend: `:gen_tcp` or `:ssl` (defaults to `:gen_tcp`)
- sasl_opts: optional. sasl only. Is a keyword list containing:
- mechanism: sasl mechanism string (eg. "PLAIN"),
- sasl_auth_vsn: api version number to use for SaslAuthenticate messages,
- sasl_handshake_vsn: api version number to use for SaslHandshake messages,
- auth_vsn: api version number to use for SaslAuthenticate messages,
- handshake_vsn: api version number to use for SaslHandshake messages,
- mechanism_opts: mechanism specific keywordlist
- any other option will be forwarded to the backend module `connect/3` function
"""
Expand Down

0 comments on commit 2e51bca

Please sign in to comment.