lib/link-header-parser.rb in link-header-parser-4.0.0 vs lib/link-header-parser.rb in link-header-parser-5.0.0

@@ -7,14 +7,23 @@
 require_relative 'link_header_parser/link_header'
 require_relative 'link_header_parser/link_header_parameter'
 require_relative 'link_header_parser/link_headers_collection'
 
 module LinkHeaderParser
-  # Parse an array of HTTP Link headers
+  # Parse an array of HTTP Link headers.
   #
-  # @param headers [Array<String>]
-  # @param base [String]
-  # @return [LinkHeaderParser::LinkHeadersCollection]
+  # Convenience method for {LinkHeaderParser::LinkHeadersCollection#initialize}.
+  #
+  # @example
+  #   require 'net/http'
+  #
+  #   url = 'https://sixtwothree.org'
+  #   link_headers = Net::HTTP.get_response(URI.parse(url)).get_fields('Link')
+  #
+  #   LinkHeaderParser.parse(link_headers, base: url)
+  #
+  # @param (see LinkHeaderParser::LinkHeadersCollection#initialize)
+  # @return (see LinkHeaderParser::LinkHeadersCollection#initialize)
   def self.parse(*headers, base:)
     LinkHeadersCollection.new(*headers, base: base)
   end
 end