Fix reportgenerator docs, fixes #2535

fsprojects · Sep 3, 2020 · 206ea55 · 206ea55
1 parent f2d76ff
commit 206ea55
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 17 deletions.
diff --git a/help/markdown/testing-reportgenerator.md b/help/markdown/testing-reportgenerator.md
@@ -19,30 +19,20 @@ See https://github.com/danielpalme/ReportGenerator
 ## Minimal working example
 
 ```fsharp
-"#r "paket:
+"#r paket:
 nuget Fake.Core.Target
 nuget Fake.Testing.ReportGenerator"
 
 open Fake.Core
 open Fake.Core.TargetOperators
 open Fake.Testing
 
-...
-
 Target.create "Generate Reports" (fun _ ->
-   let parameters p = { p with TargetDir = "c:/reports/" }
    !! "**/opencover.xml"
-   |> ReportGenerator.generateReports parameters
+   |> Seq.toList
+   |> ReportGenerator.generateReports (fun p -> { p with TargetDir = "c:/reports/" })
  )
 
-Target.create "Default" DoNothing
-
-"Clean"
-  ==> "SetAssemblyInfo"
-  ==> "Build"
-  ==> "RunCoverage"
-  ==> "Generate Reports"
-  ==> "Default"
 
-Target.runOrDefault "Default"
+Target.runOrDefault "Generate Reports"
 ```
diff --git a/src/app/Fake.Testing.ReportGenerator/ReportGenerator.fs b/src/app/Fake.Testing.ReportGenerator/ReportGenerator.fs
@@ -7,9 +7,9 @@
 /// open Fake.Testing
 ///
 /// Target.create "Generate Reports" (fun _ ->
-///   let parameters p = { p with TargetDir = "c:/reports/" }
 ///   !! "**/opencover.xml"
-///   |> ReportGenerator.generateReports parameters
+///   |> Seq.toList
+///   |> ReportGenerator.generateReports (fun p -> { p with TargetDir = "c:/reports/" })
 /// )
 /// ```
 [<RequireQualifiedAccess>]
@@ -158,7 +158,7 @@ let internal createProcess setParams (reports : string seq) =
 ///
 ///  - `setParams` - Function used to overwrite the default ReportGenerator parameters.
 ///  - `reports` - Coverage reports.
-let generateReports setParams (reports : string list) =
+let generateReports setParams (reports : string seq) =
     use __ = Trace.traceTask "ReportGenerator" "Generating reports"
 
     match reports with