Merge pull request #242 from jfmengels/documentation-improvements

Fix imports in documentation examples

Author: Janiczek

src/Expect.elm

@@ -578,9 +578,9 @@ equalSets expected actual =
 
 {-| Always passes.
 
+    import Expect
     import Json.Decode exposing (decodeString, int)
     import Test exposing (test)
-    import Expect
 
 
     test "Json.Decode.int can decode the number 42." <|
@@ -600,9 +600,9 @@ pass =
 
 {-| Fails with the given message.
 
+    import Expect
     import Json.Decode exposing (decodeString, int)
     import Test exposing (test)
-    import Expect
 
 
     test "Json.Decode.int can decode the number 42." <|

src/Test.elm

@@ -73,15 +73,15 @@ concat tests =
 
 {-| Apply a description to a list of tests.
 
-    import Test exposing (describe, test, fuzz)
-    import Fuzz exposing (int)
     import Expect
+    import Fuzz exposing (int)
+    import Test exposing (describe, fuzz, test)
 
 
     describe "List"
         [ describe "reverse"
             [ test "has no effect on an empty list" <|
-                \_ ->
+                \() ->
                     List.reverse []
                         |> Expect.equal []
             , fuzz int "has no effect on a one-item list" <|
@@ -141,12 +141,12 @@ describe untrimmedDesc tests =
 {-| Return a [`Test`](#Test) that evaluates a single
 [`Expectation`](../Expect#Expectation).
 
-    import Test exposing (fuzz)
     import Expect
+    import Test exposing (test)
 
 
     test "the empty list has 0 length" <|
-        \_ ->
+        \() ->
             List.length []
                 |> Expect.equal 0
 
@@ -213,7 +213,7 @@ an `only` inside a `skip`, it will also get skipped.
         [ only <|
             describe "reverse"
                 [ test "has no effect on an empty list" <|
-                    \_ ->
+                    \() ->
                         List.reverse []
                             |> Expect.equal []
                 , fuzz int "has no effect on a one-item list" <|
@@ -222,7 +222,7 @@ an `only` inside a `skip`, it will also get skipped.
                             |> Expect.equal [ num ]
                 ]
         , test "This will not get run, because of the `only` above!" <|
-            \_ ->
+            \() ->
                 List.length []
                     |> Expect.equal 0
         ]
@@ -249,7 +249,7 @@ an `only` inside a `skip`, it will also get skipped.
         [ skip <|
             describe "reverse"
                 [ test "has no effect on an empty list" <|
-                    \_ ->
+                    \() ->
                         List.reverse []
                             |> Expect.equal []
                 , fuzz int "has no effect on a one-item list" <|
@@ -258,7 +258,7 @@ an `only` inside a `skip`, it will also get skipped.
                             |> Expect.equal [ num ]
                 ]
         , test "This is the only test that will get run; the other was skipped!" <|
-            \_ ->
+            \() ->
                 List.length []
                     |> Expect.equal 0
         ]
@@ -276,9 +276,9 @@ skip =
 
 The number of times to run each fuzz test. (Default is 100.)
 
-    import Test exposing (fuzzWith)
-    import Fuzz exposing (list, int)
     import Expect
+    import Fuzz exposing (int, list)
+    import Test exposing (fuzzWith, noDistribution)
 
     fuzzWith { runs = 350, distribution = noDistribution }
         (list int)
@@ -297,10 +297,10 @@ The number of times to run each fuzz test. (Default is 100.)
 A way to report/enforce a statistical distribution of your input values.
 (Default is `noDistribution`.)
 
-    import Test exposing (fuzzWith)
-    import Test.Distribution
-    import Fuzz exposing (list, int)
     import Expect
+    import Fuzz exposing (int, list)
+    import Test exposing (expectDistribution, fuzzWith)
+    import Test.Distribution
 
     fuzzWith
         { runs = 350
@@ -330,9 +330,9 @@ Note that there is no `fuzzWith2`, but you can always pass more fuzz values in
 using [`Fuzz.pair`](Fuzz#pair), [`Fuzz.triple`](Fuzz#triple),
 for example like this:
 
-    import Test exposing (fuzzWith)
-    import Fuzz exposing (pair, list, int)
     import Expect
+    import Fuzz exposing (int, list, pair)
+    import Test exposing (fuzzWith, noDistribution)
 
 
     fuzzWith { runs = 4200, distribution = noDistribution }
@@ -393,10 +393,9 @@ You may find them elsewhere called [property-based tests](http://blog.jessitron.
 [generative tests](http://www.pivotaltracker.com/community/tracker-blog/generative-testing), or
 [QuickCheck-style tests](https://en.wikipedia.org/wiki/QuickCheck).
 
-    import Test exposing (fuzz)
-    import Fuzz exposing (list, int)
     import Expect
-
+    import Fuzz exposing (int, list)
+    import Test exposing (fuzz)
 
     fuzz (list int) "List.length should never be negative" <|
         -- This anonymous function will be run 100 times, each time with a
@@ -422,8 +421,9 @@ This is a convenience function that lets you skip calling [`Fuzz.pair`](Fuzz#pai
 
 See [`fuzzWith`](#fuzzWith) for an example of writing this using tuples.
 
+    import Expect
+    import Fuzz exposing (int, list)
     import Test exposing (fuzz2)
-    import Fuzz exposing (list, int)
 
 
     fuzz2 (list int) int "List.reverse never influences List.member" <|

src/Test/Html/Event.elm

@@ -54,7 +54,11 @@ type Event msg
 
 {-| Simulate an event on a node.
 
+    import Html
+    import Html.Events exposing (onInput)
+    import Test exposing (test)
     import Test.Html.Event as Event
+    import Test.Html.Query as Query
 
     type Msg
         = Change String
@@ -75,7 +79,11 @@ simulate =
 
 {-| Passes if the given message is triggered by the simulated event.
 
+    import Html
+    import Html.Events exposing (onInput)
+    import Test exposing (test)
     import Test.Html.Event as Event
+    import Test.Html.Query as Query
 
     type Msg
         = Change String
@@ -113,7 +121,11 @@ expect msg (Event event (QueryInternal.Single showTrace query)) =
 Note that Event.expect gives nicer messages; this is generally more useful
 when testing that an event handler is _not_ present.
 
+    import Html
+    import Html.Events exposing (onInput)
+    import Test exposing (test)
     import Test.Html.Event as Event
+    import Test.Html.Query as Query
 
 
     test "Input produces expected Msg" <|
@@ -309,9 +321,12 @@ focus =
 {-| Simulate a custom event. The `String` is the event name, and the `Value` is the event object
 the browser would send to the event listener callback.
 
-    import Test.Html.Event as Event
+    import Html
+    import Html.Events exposing (onInput)
     import Json.Encode as Encode exposing (Value)
-
+    import Test exposing (test)
+    import Test.Html.Event as Event
+    import Test.Html.Query as Query
 
     type Msg
         = Change String
@@ -328,10 +343,10 @@ the browser would send to the event listener callback.
                           )
                         ]
             in
-                Html.input [ onInput Change ] [ ]
-                    |> Query.fromHtml
-                    |> Event.simulate (Event.custom "input" simulatedEventObject)
-                    |> Event.expect (Change "cats")
+            Html.input [ onInput Change ] [ ]
+                |> Query.fromHtml
+                |> Event.simulate (Event.custom "input" simulatedEventObject)
+                |> Event.expect (Change "cats")
 
 -}
 custom : String -> Value -> ( String, Value )