Add documentation to Rack::Request#hostname.

rack · Feb 7, 2020 · d902198 · d902198
1 parent 7370cd4
commit d902198
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/lib/rack/request.rb b/lib/rack/request.rb
@@ -301,7 +301,10 @@ def host
         split_authority(self.authority)[0]
       end
 
-      # Returns an address suitable for being used with `getaddrinfo`.
+      # Returns an address suitable for being to resolve to an address.
+      # In the case of a domain name or IPv4 address, the result is the same
+      # as +host+. In the case of IPv6 or future address formats, the square
+      # brackets are removed.
       def hostname
         split_authority(self.authority)[1]
       end