Skip to content

Commit 58ed0ce

Browse files
CaptnCodrCaptnCodr
authored
Merge pull request #262 from CaptnCodr/feature/docs
Update docs & update copyright for 2024.
2 parents 9f4a910 + cd8cddb commit 58ed0ce

16 files changed

+45
-30
lines changed

‎RELEASE_NOTES.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
### 6.0.0.0-alpha2 - Dec 15, 2023
2-
- Migrate to NUnit v4.
1+
### 6.0.0.0 - Jan 11, 2024
32
- [BREAKING] FsUnit (NUnit v4 as dependency) drops netstandard2.0 as target framework.
4-
- Update dependencies to MsTest v3.
3+
- Migrate to NUnit v4. - (https://github.com/fsprojects/FsUnit/pull/259)
4+
- Update dependencies to MsTest v3. - (https://github.com/fsprojects/FsUnit/pull/260)
5+
- Update/Fix docs. - (https://github.com/fsprojects/FsUnit/pull/262)
56

67
### 5.6.1.0 - Nov 29, 2023
78
- Set NUnit dependency < 4.0.0 to prevent compatibility issues. - (https://github.com/fsprojects/FsUnit/pull/257)

‎docs/FsUnitTyped.fsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
(*** hide ***)
22
// This block of code is omitted in the generated HTML documentation. Use
33
// it to define helpers that you do not want to show in the documentation.
4-
#r "../packages/NUnit/lib/netstandard2.0/nunit.framework.dll"
5-
#r "../bin/FsUnit.NUnit/netstandard2.0/FsUnit.NUnit.dll"
4+
#r "../packages/NUnit/lib/net6.0/nunit.framework.dll"
5+
#r "../bin/FsUnit.NUnit/net6.0/FsUnit.NUnit.dll"
66

77
(**
88
What is FsUnitTyped?

‎docs/MsTest.fsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
(*** hide ***)
22
// This block of code is omitted in the generated HTML documentation. Use
33
// it to define helpers that you do not want to show in the documentation.
4-
#r "../packages/MSTest.TestFramework/lib/netstandard1.0/Microsoft.VisualStudio.TestPlatform.TestFramework.dll"
4+
#r "../packages/MSTest.TestFramework/lib/netstandard2.0/Microsoft.VisualStudio.TestPlatform.TestFramework.dll"
55
#r "../packages/NHamcrest/lib/netstandard2.0/NHamcrest.dll"
66
#r "../bin/FsUnit.MsTest/netstandard2.0/FsUnit.MsTest.dll"
77

‎docs/NUnit.fsx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
(*** hide ***)
22
// This block of code is omitted in the generated HTML documentation. Use
33
// it to define helpers that you do not want to show in the documentation.
4-
#r "../packages/NUnit/lib/netstandard2.0/nunit.framework.dll"
5-
#r "../bin/FsUnit.NUnit/netstandard2.0/FsUnit.NUnit.dll"
4+
#r "../packages/NUnit/lib/net6.0/nunit.framework.dll"
5+
#r "../bin/FsUnit.NUnit/net6.0/FsUnit.NUnit.dll"
66

77
open NUnit.Framework
88
(**
@@ -32,7 +32,9 @@ __SetUpFixture__
3232
Add following piece of code to your assembly to register formatter for namespace or entire assembly
3333
*)
3434
open FsUnit
35+
open NUnit.Framework
3536

37+
[<SetUpFixture>]
3638
type InitMsgUtils() =
3739
inherit FSharpCustomMessageFormatter()
3840

‎docs/_template.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ <h3 class="muted"><a href="./index.html">{{fsdocs-collection-name}}</a></h3>
8484
</div>
8585
</div>
8686
</div>
87-
<a href="https://github.com/fsprojects/FsUnit"> <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"> </a>
87+
<a href="https://github.com/fsprojects/FsUnit"> <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"> </a>
8888

8989
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
9090
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />

‎docs/index.fsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
(*** hide ***)
22
// This block of code is omitted in the generated HTML documentation. Use
33
// it to define helpers that you do not want to show in the documentation.
4-
#r "../packages/NUnit/lib/netstandard2.0/nunit.framework.dll"
5-
#r "../bin/FsUnit.NUnit/netstandard2.0/FsUnit.NUnit.dll"
4+
#r "../packages/NUnit/lib/net6.0/nunit.framework.dll"
5+
#r "../bin/FsUnit.NUnit/net6.0/FsUnit.NUnit.dll"
66

77
open FsUnit
88

‎src/FsUnit.MsTestUnit/AssemblyInfo.fs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ open System.Reflection
55
[<assembly: AssemblyTitleAttribute("FsUnit.MsTest")>]
66
[<assembly: AssemblyProductAttribute("FsUnit")>]
77
[<assembly: AssemblyDescriptionAttribute("FsUnit is a set of libraries that makes unit-testing with F# more enjoyable.")>]
8-
[<assembly: AssemblyVersionAttribute("5.6.1.0")>]
9-
[<assembly: AssemblyFileVersionAttribute("5.6.1.0")>]
8+
[<assembly: AssemblyVersionAttribute("6.0.0.0")>]
9+
[<assembly: AssemblyFileVersionAttribute("6.0.0.0")>]
1010
do ()
1111

1212
module internal AssemblyVersionInformation =
1313
let [<Literal>] AssemblyTitle = "FsUnit.MsTest"
1414
let [<Literal>] AssemblyProduct = "FsUnit"
1515
let [<Literal>] AssemblyDescription = "FsUnit is a set of libraries that makes unit-testing with F# more enjoyable."
16-
let [<Literal>] AssemblyVersion = "5.6.1.0"
17-
let [<Literal>] AssemblyFileVersion = "5.6.1.0"
16+
let [<Literal>] AssemblyVersion = "6.0.0.0"
17+
let [<Literal>] AssemblyFileVersion = "6.0.0.0"

‎src/FsUnit.MsTestUnit/paket.template

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ projectUrl
99
https://github.com/fsprojects/FsUnit
1010
iconUrl
1111
https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
12+
licenseExpression
13+
MIT
1214
licenseUrl
1315
https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
1416
requireLicenseAcceptance
1517
false
1618
copyright
17-
Copyright 2012-2023
19+
Copyright 2012-2024
1820
tags
1921
F# fsharp MsTest FsUnit
2022
summary

‎src/FsUnit.MsTestUnit/sample.paket.template

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ projectUrl
99
https://github.com/fsprojects/FsUnit
1010
iconUrl
1111
https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
12+
licenseExpression
13+
MIT
1214
licenseUrl
1315
https://github.com/fsprojects/FsUnit/blob/master/license.txt
1416
requireLicenseAcceptance
1517
false
1618
copyright
17-
Copyright 2015-2023
19+
Copyright 2015-2024
1820
tags
1921
F# fsharp MsTest FsUnit
2022
summary

‎src/FsUnit.NUnit/AssemblyInfo.fs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ open System.Reflection
55
[<assembly: AssemblyTitleAttribute("FsUnit.NUnit")>]
66
[<assembly: AssemblyProductAttribute("FsUnit")>]
77
[<assembly: AssemblyDescriptionAttribute("FsUnit is a set of libraries that makes unit-testing with F# more enjoyable.")>]
8-
[<assembly: AssemblyVersionAttribute("5.6.1.0")>]
9-
[<assembly: AssemblyFileVersionAttribute("5.6.1.0")>]
8+
[<assembly: AssemblyVersionAttribute("6.0.0.0")>]
9+
[<assembly: AssemblyFileVersionAttribute("6.0.0.0")>]
1010
do ()
1111

1212
module internal AssemblyVersionInformation =
1313
let [<Literal>] AssemblyTitle = "FsUnit.NUnit"
1414
let [<Literal>] AssemblyProduct = "FsUnit"
1515
let [<Literal>] AssemblyDescription = "FsUnit is a set of libraries that makes unit-testing with F# more enjoyable."
16-
let [<Literal>] AssemblyVersion = "5.6.1.0"
17-
let [<Literal>] AssemblyFileVersion = "5.6.1.0"
16+
let [<Literal>] AssemblyVersion = "6.0.0.0"
17+
let [<Literal>] AssemblyFileVersion = "6.0.0.0"

‎src/FsUnit.NUnit/FsUnit.NUnit.fsproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
3-
<TargetFrameworks>net6.0</TargetFrameworks>
3+
<TargetFramework>net6.0</TargetFramework>
44
<AssemblyName>FsUnit.NUnit</AssemblyName>
55
<EnableDefaultCompileItems>false</EnableDefaultCompileItems>
66
<GenerateDocumentationFile>true</GenerateDocumentationFile>

‎src/FsUnit.NUnit/paket.template

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ projectUrl
99
https://github.com/fsprojects/FsUnit
1010
iconUrl
1111
https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
12+
licenseExpression
13+
MIT
1214
licenseUrl
1315
https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
1416
requireLicenseAcceptance
1517
false
1618
copyright
17-
Copyright 2012-2023
19+
Copyright 2012-2024
1820
tags
1921
F# fsharp NUnit FsUnit
2022
summary

‎src/FsUnit.NUnit/sample.paket.template

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ projectUrl
99
https://github.com/fsprojects/FsUnit
1010
iconUrl
1111
https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
12+
licenseExpression
13+
MIT
1214
licenseUrl
1315
https://github.com/fsprojects/FsUnit/blob/master/license.txt
1416
requireLicenseAcceptance
1517
false
1618
copyright
17-
Copyright 2015-2023
19+
Copyright 2015-2024
1820
tags
1921
F# fsharp NUnit FsUnit
2022
summary

‎src/FsUnit.Xunit/AssemblyInfo.fs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ open System.Reflection
55
[<assembly: AssemblyTitleAttribute("FsUnit.Xunit")>]
66
[<assembly: AssemblyProductAttribute("FsUnit")>]
77
[<assembly: AssemblyDescriptionAttribute("FsUnit is a set of libraries that makes unit-testing with F# more enjoyable.")>]
8-
[<assembly: AssemblyVersionAttribute("5.6.1.0")>]
9-
[<assembly: AssemblyFileVersionAttribute("5.6.1.0")>]
8+
[<assembly: AssemblyVersionAttribute("6.0.0.0")>]
9+
[<assembly: AssemblyFileVersionAttribute("6.0.0.0")>]
1010
do ()
1111

1212
module internal AssemblyVersionInformation =
1313
let [<Literal>] AssemblyTitle = "FsUnit.Xunit"
1414
let [<Literal>] AssemblyProduct = "FsUnit"
1515
let [<Literal>] AssemblyDescription = "FsUnit is a set of libraries that makes unit-testing with F# more enjoyable."
16-
let [<Literal>] AssemblyVersion = "5.6.1.0"
17-
let [<Literal>] AssemblyFileVersion = "5.6.1.0"
16+
let [<Literal>] AssemblyVersion = "6.0.0.0"
17+
let [<Literal>] AssemblyFileVersion = "6.0.0.0"

‎src/FsUnit.Xunit/paket.template

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ projectUrl
99
https://github.com/fsprojects/FsUnit
1010
iconUrl
1111
https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
12+
licenseExpression
13+
MIT
1214
licenseUrl
1315
https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
1416
requireLicenseAcceptance
1517
false
1618
copyright
17-
Copyright 2012-2023
19+
Copyright 2012-2024
1820
tags
1921
F# fsharp xUnit FsUnit
2022
summary

‎src/FsUnit.Xunit/sample.paket.template

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ projectUrl
99
https://github.com/fsprojects/FsUnit
1010
iconUrl
1111
https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
12+
licenseExpression
13+
MIT
1214
licenseUrl
1315
https://github.com/fsprojects/FsUnit/blob/master/license.txt
1416
requireLicenseAcceptance
1517
false
1618
copyright
17-
Copyright 2015-2023
19+
Copyright 2015-2024
1820
tags
1921
F# fsharp xUnit FsUnit
2022
summary

0 commit comments

Comments
 (0)