Skip to content

Commit 6a75f89

Browse files
committed
Explicitly list options including ssl_context.
1 parent d5dae4a commit 6a75f89

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

lib/async/redis/endpoint.rb

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def self.parse(string, endpoint = nil, **options)
4444
#
4545
# @parameter scheme [String] The scheme to use, e.g. "redis" or "rediss".
4646
# @parameter hostname [String] The hostname to connect to (or bind to).
47-
# @parameter *options [Hash] Additional options, passed to {#initialize}.
47+
# @parameter options [Hash] Additional options, passed to {#initialize}.
4848
def self.for(scheme, hostname, credentials: nil, port: nil, database: nil, **options)
4949
uri_klass = SCHEMES.fetch(scheme.downcase) do
5050
raise ArgumentError, "Unsupported scheme: #{scheme.inspect}"
@@ -74,9 +74,10 @@ def self.[](object)
7474
#
7575
# @parameter url [URI] The URL to connect to.
7676
# @parameter endpoint [Endpoint] The underlying endpoint to use.
77-
# @parameter scheme [String] The scheme to use, e.g. "redis" or "rediss".
78-
# @parameter hostname [String] The hostname to connect to (or bind to), overrides the URL hostname (used for SNI).
79-
# @parameter port [Integer] The port to bind to, overrides the URL port.
77+
# @option scheme [String] The scheme to use, e.g. "redis" or "rediss".
78+
# @option hostname [String] The hostname to connect to (or bind to), overrides the URL hostname (used for SNI).
79+
# @option port [Integer] The port to bind to, overrides the URL port.
80+
# @option ssl_context [OpenSSL::SSL::SSLContext] The SSL context to use for secure connections.
8081
def initialize(url, endpoint = nil, **options)
8182
super(**options)
8283

0 commit comments

Comments
 (0)