From b3b4697ff8b9093cef2cc3842dab731f37c9e2e1 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Tue, 1 May 2018 14:29:11 +0200 Subject: [PATCH] `url-domain' doc clarification * lisp/url/url-util.el (url-domain): Add an example to the doc string. --- lisp/url/url-util.el | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lisp/url/url-util.el b/lisp/url/url-util.el index 9bfbca65d9a..ffae984941e 100644 --- a/lisp/url/url-util.el +++ b/lisp/url/url-util.el @@ -632,8 +632,11 @@ Creates FILE and its parent directories if they do not exist." ;;;###autoload (defun url-domain (url) - "Return the domain of the host of the url. -Return nil if this can't be determined." + "Return the domain of the host of the URL. +Return nil if this can't be determined. + +For instance, this function will return \"fsf.co.uk\" if the host in URL +is \"www.fsf.co.uk\"." (let* ((host (puny-encode-domain (url-host url))) (parts (nreverse (split-string host "\\."))) (candidate (pop parts)) -- 2.39.5