From ef1f5dfe2bf3c71cfb8b9d1e34301ba8c3cea68f Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Mon, 17 Jan 2022 19:15:30 +0200 Subject: [PATCH] Doc fixes in textsec.el * lisp/international/textsec.el (textsec-scripts) (textsec-single-script-p, textsec-covering-scripts): Clarify "script". --- lisp/international/textsec.el | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/lisp/international/textsec.el b/lisp/international/textsec.el index a13d500e082..8877a15835e 100644 --- a/lisp/international/textsec.el +++ b/lisp/international/textsec.el @@ -38,13 +38,15 @@ (require 'uni-scripts)) (defun textsec-scripts (string) - "Return a list of scripts used in STRING." + "Return a list of Unicode scripts used in STRING. +The scripts returned by this function use the Unicode Script property +as defined by the Unicode Standard Annex 24 (UAX#24)." (seq-map (lambda (char) (elt textsec--char-scripts char)) string)) (defun textsec-single-script-p (string) - "Return non-nil if STRING is all in a single script. + "Return non-nil if STRING is all in a single Unicode script. Note that the concept of \"single script\" used by this function isn't obvious -- some mixtures of scripts count as a \"single @@ -52,7 +54,8 @@ script\". See https://www.unicode.org/reports/tr39/#Mixed_Script_Detection -for details." +for details. The Unicode scripts are as defined by the +Unicode Standard Annex 24 (UAX#24)." (let ((scripts (mapcar (lambda (s) (append s @@ -90,7 +93,8 @@ for details." (defun textsec-covering-scripts (string) "Return a minimal list of scripts used in STRING. -Not that a string may have several different minimal cover sets." +Not that a string may have several different minimal cover sets. +The scripts are as defined by the Unicode Standard Annex 24 (UAX#24)." (let* ((scripts (textsec-scripts string)) (set (car scripts))) (dolist (s scripts) -- 2.39.2