Add sample user function in eww-auto-rename-buffer

* eww.el (eww-auto-rename-buffer): Update doc string.

Fix bug#51176.

Co-authored-by: Abhiseck Paira <abhiseckpaira@disroot.org>
Co-authored-by: Protesilaos Stavrou <info@protesilaos.com>

diff --git a/lisp/net/eww.el b/lisp/net/eww.el
index bed458ed8a53286d7ac072cff5725dc3811bfda4..178a25e4be2551e0055f601b4de4e1fb54c6ef1c 100644 (file)
--- a/lisp/net/eww.el
+++ b/lisp/net/eww.el
@@ -187,7 +187,14 @@ determine the renaming scheme, as follows:
 - `title': Use the web page's title.
 - `url': Use the web page's URL.
 - a function's symbol: Run a user-defined function that returns a
-  string with which to rename the buffer.
+  string with which to rename the buffer.  Sample of a
+  user-defined function:
+
+  (defun my-eww-rename-buffer ()
+    (when (eq major-mode 'eww-mode)
+      (when-let ((string (or (plist-get eww-data :title)
+                             (plist-get eww-data :url))))
+        (format \"*%s*\" string))))
 
 The string of `title' and `url' is always truncated to the value
 of `eww-buffer-name-length'."