projects
/
ghc-base.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
dbe5ad2
)
[project @ 2003-08-30 23:01:48 by ross]
author
ross
<unknown>
Sat, 30 Aug 2003 23:01:50 +0000
(23:01 +0000)
committer
ross
<unknown>
Sat, 30 Aug 2003 23:01:50 +0000
(23:01 +0000)
minor haddock fixes
Control/Exception.hs
patch
|
blob
|
history
Control/Monad.hs
patch
|
blob
|
history
Data/Array/ST.hs
patch
|
blob
|
history
Data/FiniteMap.hs
patch
|
blob
|
history
System/Directory.hs
patch
|
blob
|
history
System/IO.hs
patch
|
blob
|
history
System/Locale.hs
patch
|
blob
|
history
System/Random.hs
patch
|
blob
|
history
Text/PrettyPrint/HughesPJ.hs
patch
|
blob
|
history
Text/Regex.hs
patch
|
blob
|
history
diff --git
a/Control/Exception.hs
b/Control/Exception.hs
index
7d66da8
..
087f6fd
100644
(file)
--- a/
Control/Exception.hs
+++ b/
Control/Exception.hs
@@
-488,7
+488,7
@@
Similar arguments apply for other interruptible operations like
#ifdef __HADDOCK__
-- | If the first argument evaluates to 'True', then the result is the
#ifdef __HADDOCK__
-- | If the first argument evaluates to 'True', then the result is the
--- second argument. Otherwise an 'Assertion' exception is raised,
+-- second argument. Otherwise an 'AssertionFailed' exception is raised,
-- containing a 'String' with the source file and line number of the
-- call to assert.
--
-- containing a 'String' with the source file and line number of the
-- call to assert.
--
diff --git
a/Control/Monad.hs
b/Control/Monad.hs
index
c8cb942
..
805996f
100644
(file)
--- a/
Control/Monad.hs
+++ b/
Control/Monad.hs
@@
-254,20
+254,20
@@
ap = liftM2 id
The functions in this library use the following naming conventions:
The functions in this library use the following naming conventions:
-* A postfix `M' always stands for a function in the Kleisli category:
+* A postfix \`M\' always stands for a function in the Kleisli category:
@m@ is added to function results (modulo currying) and nowhere else.
So, for example,
> filter :: (a -> Bool) -> [a] -> [a]
> filterM :: (Monad m) => (a -> m Bool) -> [a] -> m [a]
@m@ is added to function results (modulo currying) and nowhere else.
So, for example,
> filter :: (a -> Bool) -> [a] -> [a]
> filterM :: (Monad m) => (a -> m Bool) -> [a] -> m [a]
-* A postfix `_' changes the result type from @(m a)@ to @(m ())@.
+* A postfix \`_\' changes the result type from @(m a)@ to @(m ())@.
Thus (in the "Prelude"):
> sequence :: Monad m => [m a] -> m [a]
> sequence_ :: Monad m => [m a] -> m ()
Thus (in the "Prelude"):
> sequence :: Monad m => [m a] -> m [a]
> sequence_ :: Monad m => [m a] -> m ()
-* A prefix `m' generalises an existing function to a monadic form.
+* A prefix \`m\' generalises an existing function to a monadic form.
Thus, for example:
> sum :: Num a => [a] -> a
Thus, for example:
> sum :: Num a => [a] -> a
diff --git
a/Data/Array/ST.hs
b/Data/Array/ST.hs
index
4982de8
..
507ba60
100644
(file)
--- a/
Data/Array/ST.hs
+++ b/
Data/Array/ST.hs
@@
-8,7
+8,7
@@
-- Stability : experimental
-- Portability : non-portable
--
-- Stability : experimental
-- Portability : non-portable
--
--- Mutable boxed and unboxed arrays in the 'ST' monad.
+-- Mutable boxed and unboxed arrays in the 'Control.Monad.ST.ST' monad.
--
-----------------------------------------------------------------------------
--
-----------------------------------------------------------------------------
diff --git
a/Data/FiniteMap.hs
b/Data/FiniteMap.hs
index
3b1b785
..
96a9faf
100644
(file)
--- a/
Data/FiniteMap.hs
+++ b/
Data/FiniteMap.hs
@@
-159,12
+159,12
@@
delFromFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> key -> FiniteMap
-- | List version of 'delFromFM'.
delListFromFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> [key] -> FiniteMap key elt
-- | List version of 'delFromFM'.
delListFromFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> [key] -> FiniteMap key elt
--- | Combine two 'FiniteMaps'. Mappings in the second argument shadow
+-- | Combine two 'FiniteMap's. Mappings in the second argument shadow
-- those in the first.
plusFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt
-> FiniteMap key elt
-- those in the first.
plusFM :: (Ord key OUTPUTABLE_key) => FiniteMap key elt -> FiniteMap key elt
-> FiniteMap key elt
--- | Combine two 'FiniteMaps'. The specified combination function is
+-- | Combine two 'FiniteMap's. The specified combination function is
-- used to calculate the new value when there are two elements with
-- the same key.
plusFM_C :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
-- used to calculate the new value when there are two elements with
-- the same key.
plusFM_C :: (Ord key OUTPUTABLE_key) => (elt -> elt -> elt)
diff --git
a/System/Directory.hs
b/System/Directory.hs
index
0383b82
..
f4e1807
100644
(file)
--- a/
System/Directory.hs
+++ b/
System/Directory.hs
@@
-236,7
+236,7
@@
EIO
The operand is not a valid directory name.
[ENAMETOOLONG, ELOOP]
The operand is not a valid directory name.
[ENAMETOOLONG, ELOOP]
-* 'isDoesNotExist' 'NoSuchThing'
+* 'isDoesNotExistError' \/ 'NoSuchThing'
The directory does not exist.
@[ENOENT, ENOTDIR]@
The directory does not exist.
@[ENOENT, ENOTDIR]@
@@
-264,7
+264,7
@@
removeDirectory path = do
withCString path $ \s ->
throwErrnoIfMinus1Retry_ "removeDirectory" (c_rmdir s)
withCString path $ \s ->
throwErrnoIfMinus1Retry_ "removeDirectory" (c_rmdir s)
-{- |@'removefile' file@ removes the directory entry for an existing file
+{- |'removeFile' /file/ removes the directory entry for an existing file
/file/, where /file/ is not itself a directory. The
implementation may specify additional constraints which must be
satisfied before a file can be removed (e.g. the file may not be in
/file/, where /file/ is not itself a directory. The
implementation may specify additional constraints which must be
satisfied before a file can be removed (e.g. the file may not be in
@@
-274,13
+274,13
@@
The operation may fail with:
* 'HardwareFault'
A physical I\/O error has occurred.
* 'HardwareFault'
A physical I\/O error has occurred.
-'EIO'
+@[EIO]@
* 'InvalidArgument'
The operand is not a valid file name.
@[ENAMETOOLONG, ELOOP]@
* 'InvalidArgument'
The operand is not a valid file name.
@[ENAMETOOLONG, ELOOP]@
-* 'isDoesNotExist' \/ 'NoSuchThing'
+* 'isDoesNotExistError' \/ 'NoSuchThing'
The file does not exist.
@[ENOENT, ENOTDIR]@
The file does not exist.
@[ENOENT, ENOTDIR]@
diff --git
a/System/IO.hs
b/System/IO.hs
index
eee562c
..
5d0f0a7
100644
(file)
--- a/
System/IO.hs
+++ b/
System/IO.hs
@@
-341,7
+341,7
@@
readIO s = case (do { (x,t) <- reads s ;
#endif /* __HUGS__ */
-- | Computation 'hReady' @hdl@ indicates whether at least one item is
#endif /* __HUGS__ */
-- | Computation 'hReady' @hdl@ indicates whether at least one item is
--- available for input from handle "hdl".
+-- available for input from handle @hdl@.
--
-- This operation may fail with:
--
--
-- This operation may fail with:
--
diff --git
a/System/Locale.hs
b/System/Locale.hs
index
582d288
..
3dde0f4
100644
(file)
--- a/
System/Locale.hs
+++ b/
System/Locale.hs
@@
-8,16
+8,14
@@
-- Stability : provisional
-- Portability : portable
--
-- Stability : provisional
-- Portability : portable
--
--- Operations for defining locale-specific date and time formats.
+-- This module provides the ability to adapt to local conventions.
+-- At present, it supports only time and date information as used by
+-- 'System.Time.calendarTimeToString' from the "System.Time" module.
--
-----------------------------------------------------------------------------
module System.Locale (
--
-----------------------------------------------------------------------------
module System.Locale (
- -- |The 'Locale' library provides the ability to adapt to local conventions.
- -- At present, it supports only time and date information as used by
- -- 'calendarTimeToString' from the "System.Time" library.
-
TimeLocale(..)
, defaultTimeLocale
TimeLocale(..)
, defaultTimeLocale
diff --git
a/System/Random.hs
b/System/Random.hs
index
98420e1
..
09a4a39
100644
(file)
--- a/
System/Random.hs
+++ b/
System/Random.hs
@@
-388,7
+388,7
@@
newStdGen = do
{- |'getStdRandom' uses the supplied function to get a value from the current
global random generator, and updates the global generator with the new generator
{- |'getStdRandom' uses the supplied function to get a value from the current
global random generator, and updates the global generator with the new generator
-returned by the function. For example, 'rollDice' gets a random integer between 1 and 6:
+returned by the function. For example, @rollDice@ gets a random integer between 1 and 6:
> rollDice :: IO Int
> rollDice = getStdRandom (randomR (1,6))
> rollDice :: IO Int
> rollDice = getStdRandom (randomR (1,6))
diff --git
a/Text/PrettyPrint/HughesPJ.hs
b/Text/PrettyPrint/HughesPJ.hs
index
3585ceb
..
7e1efe2
100644
(file)
--- a/
Text/PrettyPrint/HughesPJ.hs
+++ b/
Text/PrettyPrint/HughesPJ.hs
@@
-251,7
+251,7
@@
rational :: Rational -> Doc
parens :: Doc -> Doc; -- ^ Wrap document in @(...)@
brackets :: Doc -> Doc; -- ^ Wrap document in @[...]@
braces :: Doc -> Doc; -- ^ Wrap document in @{...}@
parens :: Doc -> Doc; -- ^ Wrap document in @(...)@
brackets :: Doc -> Doc; -- ^ Wrap document in @[...]@
braces :: Doc -> Doc; -- ^ Wrap document in @{...}@
-quotes :: Doc -> Doc; -- ^ Wrap document in @'...'@
+quotes :: Doc -> Doc; -- ^ Wrap document in @\'...\'@
doubleQuotes :: Doc -> Doc; -- ^ Wrap document in @\"...\"@
-- Combining @Doc@ values
doubleQuotes :: Doc -> Doc; -- ^ Wrap document in @\"...\"@
-- Combining @Doc@ values
@@
-263,6
+263,7
@@
hsep :: [Doc] -> Doc; -- ^List version of '<+>'
($$) :: Doc -> Doc -> Doc; -- ^Above; if there is no
-- overlap it \"dovetails\" the two
($$) :: Doc -> Doc -> Doc; -- ^Above; if there is no
-- overlap it \"dovetails\" the two
+($+$) :: Doc -> Doc -> Doc; -- ^Above, without dovetailing.
vcat :: [Doc] -> Doc; -- ^List version of '$$'
cat :: [Doc] -> Doc; -- ^ Either hcat or vcat
vcat :: [Doc] -> Doc; -- ^List version of '$$'
cat :: [Doc] -> Doc; -- ^ Either hcat or vcat
@@
-910,4
+911,4
@@
spaces n | n <= 0 = ""
(TextDetails_Chr 'a') 1 (Doc_NilAbove (Doc_Nest (-5) (Doc_TextBeside
(TextDetails_Chr 'a') 1 (Doc_NilAbove (Doc_Nest (-5) (Doc_TextBeside
(TextDetails_Chr 'a') 1 Doc_Empty))))))))))) (Doc_NilAbove (Doc_Nest
(TextDetails_Chr 'a') 1 (Doc_NilAbove (Doc_Nest (-5) (Doc_TextBeside
(TextDetails_Chr 'a') 1 (Doc_NilAbove (Doc_Nest (-5) (Doc_TextBeside
(TextDetails_Chr 'a') 1 Doc_Empty))))))))))) (Doc_NilAbove (Doc_Nest
--}
\ No newline at end of file
+-}
diff --git
a/Text/Regex.hs
b/Text/Regex.hs
index
a0af8cd
..
15aecb8
100644
(file)
--- a/
Text/Regex.hs
+++ b/
Text/Regex.hs
@@
-38,8
+38,8
@@
mkRegex s = unsafePerformIO (RE.regcomp s RE.regExtended)
-- case-sensitve options can be changed from the default settings.
mkRegexWithOpts
:: String -- ^ The regular expression to compile
-- case-sensitve options can be changed from the default settings.
mkRegexWithOpts
:: String -- ^ The regular expression to compile
- -> Bool -- ^ 'True' @\<=>@ '@^@' and '@$@' match the beginning and
- -- end of individual lines respectively, and '.' does /not/
+ -> Bool -- ^ 'True' @\<=>@ @\'^\'@ and @\'$\'@ match the beginning and
+ -- end of individual lines respectively, and @\'.\'@ does /not/
-- match the newline character.
-> Bool -- ^ 'True' @\<=>@ matching is case-sensitive
-> Regex -- ^ Returns: the compiled regular expression
-- match the newline character.
-> Bool -- ^ 'True' @\<=>@ matching is case-sensitive
-> Regex -- ^ Returns: the compiled regular expression