From ea2dd97cc65d61d640027d110424d023ce70f552 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Thu, 21 Dec 2023 17:24:11 -0600 Subject: [PATCH] docs(is_external_link): Fix numpydoc styling --- alagitpull/writers/external.py | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/alagitpull/writers/external.py b/alagitpull/writers/external.py index a233d65..9cc284b 100644 --- a/alagitpull/writers/external.py +++ b/alagitpull/writers/external.py @@ -17,12 +17,17 @@ def is_external_link(url, internal_hosts): """Determine if a URL is internal or external - :param url: url to check if off-site - :type url: string - :param hosts: whitelist of host TLD/IP's that are internal - :type hosts: list - :returns: whether url is internal or external to website - :rtype: value + Parameters + ---------- + url : str + url to check if off-site + hosts : str + whitelist of host TLD/IP's that are internal + + Returns + ------- + bool + whether url is internal or external to website """ tld = urlparse(url).hostname or url return (