From b044a63910acba524f5e3df24ad1ed1b99088cce Mon Sep 17 00:00:00 2001 From: Egor Kislitsyn Date: Fri, 21 Jun 2019 18:27:01 +0700 Subject: [PATCH] Add doc to `valid_tld?/2` --- lib/auto_linker/parser.ex | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/lib/auto_linker/parser.ex b/lib/auto_linker/parser.ex index 006258d..78a9e8c 100644 --- a/lib/auto_linker/parser.ex +++ b/lib/auto_linker/parser.ex @@ -311,8 +311,15 @@ defmodule AutoLinker.Parser do defp valid_url?(url), do: !Regex.match?(@invalid_url, url) - def valid_tld?(buffer, opts) do - [scheme, host] = Regex.run(@match_hostname, buffer, capture: [:scheme, :host]) + @doc """ + Validates a URL's TLD. Returns a boolean. + + Will return `true` if `:validate_tld` option set to `false`. + + Will skip validation and return `true` if `:validate_tld` set to `:no_scheme` and the url has a scheme. + """ + def valid_tld?(url, opts) do + [scheme, host] = Regex.run(@match_hostname, url, capture: [:scheme, :host]) cond do opts[:validate_tld] == false ->