From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Tue, 1 May 2018 12:29:11 +0000 (+0200)
Subject: `url-domain' doc clarification
X-Git-Tag: emacs-27.0.90~5070
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b3b4697ff8b9093cef2cc3842dab731f37c9e2e1;p=emacs.git

`url-domain' doc clarification

* lisp/url/url-util.el (url-domain): Add an example to the doc
string.
---

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))