added more info on how addressable URI differs from what we use in UrlValidator

This commit is contained in:
James Lopez 2016-06-24 11:35:32 +02:00
parent 58c49966fa
commit 8076d38a14
1 changed files with 3 additions and 1 deletions

View File

@ -1,6 +1,8 @@
# AddressableUrlValidator
#
# Custom validator for URLs. This is a stricter version of UrlValidator.
# Custom validator for URLs. This is a stricter version of UrlValidator - it also checks
# for using the right protocol, but it actually parses the URL checking for any syntax errors.
# The regex is also different from `URI` as we use `Addressable::URI` here.
#
# By default, only URLs for http, https, ssh, and git protocols will be considered valid.
# Provide a `:protocols` option to configure accepted protocols.