summaryrefslogtreecommitdiff
path: root/src/Propellor/Property/Locale.hs
diff options
context:
space:
mode:
authorSean Whitton2015-11-25 19:58:24 -0700
committerJoey Hess2015-11-26 07:09:40 -0400
commit38049b96f6e9d21e49ec159ee4998191a5b247cf (patch)
treed6cd5cc5a51cfe7f8d571daca2679b97a0b72d18 /src/Propellor/Property/Locale.hs
parent22ccf0233a1400453ece2556be744ff272349933 (diff)
improve Haddock for Locale.selectedFor
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name> (cherry picked from commit ca016d391e2419856e1efc40cc977af6a99af7d6)
Diffstat (limited to 'src/Propellor/Property/Locale.hs')
-rw-r--r--src/Propellor/Property/Locale.hs8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/Propellor/Property/Locale.hs b/src/Propellor/Property/Locale.hs
index b179094f..420dafb4 100644
--- a/src/Propellor/Property/Locale.hs
+++ b/src/Propellor/Property/Locale.hs
@@ -12,8 +12,12 @@ type LocaleVariable = String
-- | Select a locale for a list of global locale variables.
--
--- A locale variable is of the form `LC_BLAH`, `LANG` or `LANGUAGE`. See `man 5
--- locale`.
+-- A locale variable is of the form @LC_BLAH@, @LANG@ or @LANGUAGE@. See @man 5
+-- locale@. One might say
+--
+-- > & "en_GB.UTF-8" `Locale.selectedFor` ["LC_PAPER", "LC_MONETARY"]
+--
+-- to select the British English locale for paper size and currency conventions.
--
-- Note that reverting this property does not make a locale unavailable. That's
-- because it might be required for other Locale.selectedFor statements.