lib/scrivito/routing_helper.rb in scrivito_sdk-0.66.0 vs lib/scrivito/routing_helper.rb in scrivito_sdk-0.70.0.rc1

@@ -1,38 +1,38 @@
 module Scrivito
   #
-  # The helper contains methods to generate URLs to CMS content.
+  # This helper contains methods for generating URLs that point to CMS content.
   # Use {Scrivito::RoutingHelper#scrivito_path} or {Scrivito::RoutingHelper#scrivito_url} when linking or
-  # redirecting to CMS objects. These methods are available in boths your views and your controllers.
+  # redirecting to CMS objects. These methods are available in both your views and your controllers.
   #
   # @api public
   #
   module RoutingHelper
     #
-    # Returns the (URL-)path for a cms object.
+    # Returns the (URL-)path of a CMS object.
     #
     # @api public
     #
     # @param target [Obj, Link, Array<Link>, Binary]
     #   If +target+ is an +Array+ of +Links+, it must be non-empty.
-    #   The first {Link} from the +Array+ will be used.
-    # @param options [Hash] include url settings such as path parameters or protocol.
+    #   Only the first {Link} of the +Array+ is used.
+    # @param options [Hash] include url settings such as path parameters or the protocol.
     #
     # @return [String]
     #
     def scrivito_path(target, options = {})
       CmsRouting.new(request, main_app, scrivito_engine).path_or_url(target, "path", options)
     end
 
     #
-    # Returns the absolute URL for a cms object.
+    # Returns the absolute URL of a CMS object.
     #
     # @api public
     #
     # @param target [Obj, Link, Array<Link>, Binary]
     #   If +target+ is an +Array+ of +Links+, it must be non-empty.
-    #   The first {Link} from the +Array+ will be used.
-    # @param options [Hash] include url settings such as path parameters or protocol.
+    #   Only the first {Link} of the +Array+ is used.
+    # @param options [Hash] include url settings such as path parameters or the protocol.
     #
     # @return [String]
     #
     def scrivito_url(target, options = {})
       CmsRouting.new(request, main_app, scrivito_engine).path_or_url(target, "url", options)