Make it easier to discover the format fp trick. Fixes #97

Gabriella439 · Aug 22, 2015 · a2fff2a · a2fff2a
1 parent cffe0ef
commit a2fff2a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/Turtle/Prelude.hs b/src/Turtle/Prelude.hs
@@ -52,6 +52,12 @@
 -- 456
 -- ABC
 --
+-- Format strings in a type safe way using `format`:
+--
+-- >>> dir <- pwd
+-- >>> format ("I am in the "%fp%" directory") dir
+-- "I am in the /tmp directory"
+--
 -- Commands like `grep`, `sed` and `find` accept arbitrary `Pattern`s
 --
 -- >>> stdout (grep ("123" <|> "ABC") (input "foo.txt"))

diff --git a/src/Turtle/Tutorial.hs b/src/Turtle/Tutorial.hs
@@ -777,6 +777,10 @@ import Turtle
 -- another argument of type `Int` to satisfy the `d` at the end of the format
 -- string.
 --
+-- Note that this is also the idiomatic way to convert a `FilePath` to `Text`:
+--
+-- > format fp :: FilePath -> Text
+--
 -- If you are interested in this feature, check out the "Turtle.Format" module
 -- for more details.