Explorar el Código

More doc refactoring for Common

Getty Ritter hace 9 años
padre
commit
7d527236e9
Se han modificado 1 ficheros con 16 adiciones y 6 borrados
  1. 16 6
      Data/SCargot/Common.hs

+ 16 - 6
Data/SCargot/Common.hs

@@ -1,5 +1,10 @@
-module Data.SCargot.Common ( -- * Numeric Literal Parsers
-                             binNumber
+module Data.SCargot.Common ( -- $intro
+                           -- * Lisp Identifier Syntaxes
+                             parseR5RSIdent
+                           , parseR6RSIdent
+                           , parseR7RSIdent
+                             -- * Numeric Literal Parsers
+                           , binNumber
                            , signedBinNumber
                            , octNumber
                            , signedOctNumber
@@ -10,10 +15,6 @@ module Data.SCargot.Common ( -- * Numeric Literal Parsers
                            , hexNumber
                            , signedHexNumber
                            , signed
-                           -- * Lisp Identifier Syntaxes
-                           , parseR5RSIdent
-                           , parseR6RSIdent
-                           , parseR7RSIdent
                            ) where
 
 import           Data.Char
@@ -184,3 +185,12 @@ hexNumber = number 16 hexDigit
 -- | A parser for signed hexadecimal numbers, with an optional leading @+@ or @-@.
 signedHexNumber :: Parser Integer
 signedHexNumber = ($) <$> sign <*> hexNumber
+
+{- $intro
+
+This module contains a selection of parsers for different kinds of
+identifiers and literals, from which more elaborate parsers can be
+assembled. These can afford the user a quick way of building parsers
+for different atom types.
+
+-}