[Git][ghc/ghc][master] docs(Data.Char):Add more detailed descriptions for some functions

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
fae472a9 by Wendao Lee at 2023-12-08T05:49:12-05:00
docs(Data.Char):Add more detailed descriptions for some functions

Related changed function's docs:

-GHC.Unicode.isAlpha
-GHC.Unicode.isPrint
-GHC.Unicode.isAlphaNum

Add more details for what the function will return.

Co-authored-by: Bodigrim <andrew.lelechenko at gmail.com>

- - - - -


1 changed file:

- libraries/base/src/GHC/Unicode.hs


Changes:

=====================================
libraries/base/src/GHC/Unicode.hs
=====================================
@@ -208,6 +208,17 @@ isControl c = case generalCategory c of
 
 -- | Selects printable Unicode characters
 -- (letters, numbers, marks, punctuation, symbols and spaces).
+--
+-- This function returns 'False' if its argument has one of the
+-- following 'GeneralCategory's, or 'True' otherwise:
+--
+-- * 'LineSeparator'
+-- * 'ParagraphSeparator'
+-- * 'Control'
+-- * 'Format'
+-- * 'Surrogate'
+-- * 'PrivateUse'
+-- * 'NotAssigned'
 isPrint                 :: Char -> Bool
 isPrint c = case generalCategory c of
         LineSeparator      -> False
@@ -302,6 +313,20 @@ isLowerCase = DCP.isLowercase
 -- | Selects alphabetic Unicode characters (lower-case, upper-case and
 -- title-case letters, plus letters of caseless scripts and modifiers letters).
 -- This function is equivalent to 'Data.Char.isLetter'.
+--
+-- This function returns 'True' if its argument has one of the
+-- following 'GeneralCategory's, or 'False' otherwise:
+--
+-- * 'UppercaseLetter'
+-- * 'LowercaseLetter'
+-- * 'TitlecaseLetter'
+-- * 'ModifierLetter'
+-- * 'OtherLetter'
+--
+-- These classes are defined in the
+-- <http://www.unicode.org/reports/tr44/tr44-14.html#GC_Values_Table Unicode Character Database>,
+-- part of the Unicode standard. The same document defines what is
+-- and is not a \"Letter\".
 isAlpha                 :: Char -> Bool
 isAlpha c = case generalCategory c of
         UppercaseLetter -> True
@@ -316,7 +341,20 @@ isAlpha c = case generalCategory c of
 -- Note that numeric digits outside the ASCII range, as well as numeric
 -- characters which aren't digits, are selected by this function but not by
 -- 'isDigit'. Such characters may be part of identifiers but are not used by
--- the printer and reader to represent numbers.
+-- the printer and reader to represent numbers, e.g., Roman numerals like @'V'@,
+-- full-width digits like @'１'@ (aka @'\65297'@).
+--
+-- This function returns 'True' if its argument has one of the
+-- following 'GeneralCategory's, or 'False' otherwise:
+--
+-- * 'UppercaseLetter'
+-- * 'LowercaseLetter'
+-- * 'TitlecaseLetter'
+-- * 'ModifierLetter'
+-- * 'OtherLetter'
+-- * 'DecimalNumber'
+-- * 'LetterNumber'
+-- * 'OtherNumber'
 isAlphaNum              :: Char -> Bool
 isAlphaNum c = case generalCategory c of
         UppercaseLetter -> True



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/fae472a94a9fccf7a29aaad1b90c003265231a1e

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/fae472a94a9fccf7a29aaad1b90c003265231a1e
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20231208/91d1fa60/attachment-0001.html>