[project @ 2003-11-26 09:55:22 by simonmar]

[ghc-base.git] / System / Locale.hs

diff --git a/System/Locale.hs b/System/Locale.hs
index cdef8ee..f2b21b7 100644 (file)
--- a/System/Locale.hs
+++ b/System/Locale.hs
@@ -2,18 +2,22 @@
 -- |
 -- Module      :  System.Locale
 -- Copyright   :  (c) The University of Glasgow 2001
--- License     :  BSD-style (see the file libraries/core/LICENSE)
+-- License     :  BSD-style (see the file libraries/base/LICENSE)
 -- 
 -- Maintainer  :  libraries@haskell.org
--- Stability   :  provisional
+-- Stability   :  stable
 -- 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
-    ( TimeLocale(..)
+module System.Locale (
+
+    TimeLocale(..)
+
     , defaultTimeLocale
     
     , iso8601DateFormat
@@ -24,11 +28,15 @@ where
 import Prelude
 
 data TimeLocale = TimeLocale {
-        wDays  :: [(String, String)],   -- full and abbreviated week days
-        months :: [(String, String)],   -- full and abbreviated months
+       -- |full and abbreviated week days
+        wDays  :: [(String, String)],
+       -- |full and abbreviated months
+        months :: [(String, String)],
         intervals :: [(String, String)],
-        amPm   :: (String, String),     -- AM/PM symbols
-        dateTimeFmt, dateFmt,           -- formatting strings
+       -- |AM\/PM symbols
+        amPm   :: (String, String),
+       -- |formatting strings
+        dateTimeFmt, dateFmt,
         timeFmt, time12Fmt :: String     
         } deriving (Eq, Ord, Show)
 
@@ -63,11 +71,14 @@ defaultTimeLocale =  TimeLocale {
         }
 
 
+-- |Normally, ISO-8601 just defines YYYY-MM-DD
+-- but we can add a time spec.
+
 iso8601DateFormat :: Maybe String -> String
 iso8601DateFormat timeFmt =
     "%Y-%m-%d" ++ case timeFmt of
-             Nothing  -> "" -- normally, ISO-8601 just defines YYYY-MM-DD
-             Just fmt -> ' ' : fmt -- but we can add a time spec
+             Nothing  -> "" 
+             Just fmt -> ' ' : fmt
 
 
 rfc822DateFormat :: String