Skip to content

Commit

Permalink
Merge pull request #1907 from magicmonty/docs
Browse files Browse the repository at this point in the history
API Reference links for docs of SpecFlow, Pickles and ReportGenerator
  • Loading branch information
matthid authored May 4, 2018
2 parents 72df3f0 + 09d00c6 commit 2744942
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions help/markdown/fake-dotnet-testing-specflow.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Make BDD with Gherkin and SpecFlow

**Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](apidocs/v4/fake-specflowhelper.html)**

Use [SpecFlow] to define, manage and automatically execute human-readable acceptance tests in .NET projects. Writing easily understandable tests is a cornerstone of the BDD paradigm and also helps build up a living documentation of your system.

SpecFlow is open source and provided under a BSD license. As part of the Cucumber family, SpecFlow uses the official Gherkin parser and supports the .NET framework, Xamarin and Mono.

The package Fake.DotNet.Testing.SpecFlow is a bridge to the [SpecFlow] CLI (specflow.exe).

[API-Reference](https://fake.build/apidocs/v5/fake-dotnet-testing-specflow.html)

## Minimal working example

```fsharp
Expand Down
4 changes: 4 additions & 0 deletions help/markdown/fake-tools-pickles.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Convert Gherkin to HTML with Pickles

**Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](apidocs/v4/fake-pickleshelper.html)**

[Pickles] is a Living Documentation generator: it takes your Specification (written in Gherkin, with Markdown descriptions) and turns them into an always up-to-date documentation of the current state of your software - in a variety of formats.

[API-Reference](apidocs/v5/fake-tools-pickles.html)

## Minimal working example

```fsharp
Expand Down
4 changes: 4 additions & 0 deletions help/markdown/testing-reportgenerator.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Fake.Testing.ReportGenerator

**Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](apidocs/v4/fake-specflowhelper.html)**

ReportGenerator converts XML reports generated by OpenCover, PartCover, dotCover, Visual Studio, NCover or Cobertura into human readable reports in various formats.

he reports do not only show the coverage quota, but also include the source code and visualize which lines have been covered.
Expand All @@ -8,6 +10,8 @@ ReportGenerator supports merging several reports into one. It is also possible t

See https://github.com/danielpalme/ReportGenerator

[API-Reference](apidocs/v5/fake-testing-reportgenerator.html)

## Minimal working example

```fsharp
Expand Down

0 comments on commit 2744942

Please sign in to comment.