Merge pull request #262 from CaptnCodr/feature/docs

Update docs & update copyright for 2024.
fsprojects · Jan 11, 2024 · 58ed0ce · 58ed0ce
2 parents 9f4a910 + cd8cddb
commit 58ed0ce
Show file tree

Hide file tree

Showing 16 changed files with 45 additions and 30 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,7 +1,8 @@
-### 6.0.0.0-alpha2 - Dec 15, 2023
-- Migrate to NUnit v4.
+### 6.0.0.0 - Jan 11, 2024
 - [BREAKING] FsUnit (NUnit v4 as dependency) drops netstandard2.0 as target framework.
-- Update dependencies to MsTest v3.
+- Migrate to NUnit v4. - (https://github.com/fsprojects/FsUnit/pull/259)
+- Update dependencies to MsTest v3. - (https://github.com/fsprojects/FsUnit/pull/260)
+- Update/Fix docs. - (https://github.com/fsprojects/FsUnit/pull/262)
 
 ### 5.6.1.0 - Nov 29, 2023
 - Set NUnit dependency < 4.0.0 to prevent compatibility issues. - (https://github.com/fsprojects/FsUnit/pull/257)

diff --git a/docs/FsUnitTyped.fsx b/docs/FsUnitTyped.fsx
@@ -1,8 +1,8 @@
 (*** hide ***)
 // This block of code is omitted in the generated HTML documentation. Use
 // it to define helpers that you do not want to show in the documentation.
-#r "../packages/NUnit/lib/netstandard2.0/nunit.framework.dll"
-#r "../bin/FsUnit.NUnit/netstandard2.0/FsUnit.NUnit.dll"
+#r "../packages/NUnit/lib/net6.0/nunit.framework.dll"
+#r "../bin/FsUnit.NUnit/net6.0/FsUnit.NUnit.dll"
 
 (**
 What is FsUnitTyped?

diff --git a/docs/MsTest.fsx b/docs/MsTest.fsx
@@ -1,7 +1,7 @@
 (*** hide ***)
 // This block of code is omitted in the generated HTML documentation. Use
 // it to define helpers that you do not want to show in the documentation.
-#r "../packages/MSTest.TestFramework/lib/netstandard1.0/Microsoft.VisualStudio.TestPlatform.TestFramework.dll"
+#r "../packages/MSTest.TestFramework/lib/netstandard2.0/Microsoft.VisualStudio.TestPlatform.TestFramework.dll"
 #r "../packages/NHamcrest/lib/netstandard2.0/NHamcrest.dll"
 #r "../bin/FsUnit.MsTest/netstandard2.0/FsUnit.MsTest.dll"
 

diff --git a/docs/NUnit.fsx b/docs/NUnit.fsx
@@ -1,8 +1,8 @@
 (*** hide ***)
 // This block of code is omitted in the generated HTML documentation. Use
 // it to define helpers that you do not want to show in the documentation.
-#r "../packages/NUnit/lib/netstandard2.0/nunit.framework.dll"
-#r "../bin/FsUnit.NUnit/netstandard2.0/FsUnit.NUnit.dll"
+#r "../packages/NUnit/lib/net6.0/nunit.framework.dll"
+#r "../bin/FsUnit.NUnit/net6.0/FsUnit.NUnit.dll"
 
 open NUnit.Framework
 (**
@@ -32,7 +32,9 @@ __SetUpFixture__
 Add following piece of code to your assembly to register formatter for namespace or entire assembly
 *)
 open FsUnit
+open NUnit.Framework
 
+[<SetUpFixture>]
 type InitMsgUtils() =
     inherit FSharpCustomMessageFormatter()
 

diff --git a/docs/_template.html b/docs/_template.html
@@ -84,7 +84,7 @@ <h3 class="muted"><a href="./index.html">{{fsdocs-collection-name}}</a></h3>
             </div>
         </div>
     </div>
-    <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>
+    <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>
 
     <!-- BEGIN SEARCH BOX: this adds support for the search box -->
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />

diff --git a/docs/index.fsx b/docs/index.fsx
@@ -1,8 +1,8 @@
 (*** hide ***)
 // This block of code is omitted in the generated HTML documentation. Use
 // it to define helpers that you do not want to show in the documentation.
-#r "../packages/NUnit/lib/netstandard2.0/nunit.framework.dll"
-#r "../bin/FsUnit.NUnit/netstandard2.0/FsUnit.NUnit.dll"
+#r "../packages/NUnit/lib/net6.0/nunit.framework.dll"
+#r "../bin/FsUnit.NUnit/net6.0/FsUnit.NUnit.dll"
 
 open FsUnit
 

diff --git a/src/FsUnit.MsTestUnit/AssemblyInfo.fs b/src/FsUnit.MsTestUnit/AssemblyInfo.fs
@@ -5,13 +5,13 @@ open System.Reflection
 [<assembly: AssemblyTitleAttribute("FsUnit.MsTest")>]
 [<assembly: AssemblyProductAttribute("FsUnit")>]
 [<assembly: AssemblyDescriptionAttribute("FsUnit is a set of libraries that makes unit-testing with F# more enjoyable.")>]
-[<assembly: AssemblyVersionAttribute("5.6.1.0")>]
-[<assembly: AssemblyFileVersionAttribute("5.6.1.0")>]
+[<assembly: AssemblyVersionAttribute("6.0.0.0")>]
+[<assembly: AssemblyFileVersionAttribute("6.0.0.0")>]
 do ()
 
 module internal AssemblyVersionInformation =
     let [<Literal>] AssemblyTitle = "FsUnit.MsTest"
     let [<Literal>] AssemblyProduct = "FsUnit"
     let [<Literal>] AssemblyDescription = "FsUnit is a set of libraries that makes unit-testing with F# more enjoyable."
-    let [<Literal>] AssemblyVersion = "5.6.1.0"
-    let [<Literal>] AssemblyFileVersion = "5.6.1.0"
+    let [<Literal>] AssemblyVersion = "6.0.0.0"
+    let [<Literal>] AssemblyFileVersion = "6.0.0.0"
diff --git a/src/FsUnit.MsTestUnit/paket.template b/src/FsUnit.MsTestUnit/paket.template
@@ -9,12 +9,14 @@ projectUrl
     https://github.com/fsprojects/FsUnit
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
+licenseExpression
+    MIT
 licenseUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
 requireLicenseAcceptance
     false
 copyright
-    Copyright 2012-2023
+    Copyright 2012-2024
 tags
     F# fsharp MsTest FsUnit
 summary

diff --git a/src/FsUnit.MsTestUnit/sample.paket.template b/src/FsUnit.MsTestUnit/sample.paket.template
@@ -9,12 +9,14 @@ projectUrl
     https://github.com/fsprojects/FsUnit
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
+licenseExpression
+    MIT
 licenseUrl
     https://github.com/fsprojects/FsUnit/blob/master/license.txt
 requireLicenseAcceptance
     false
 copyright
-    Copyright 2015-2023
+    Copyright 2015-2024
 tags
     F# fsharp MsTest FsUnit
 summary

diff --git a/src/FsUnit.NUnit/AssemblyInfo.fs b/src/FsUnit.NUnit/AssemblyInfo.fs
@@ -5,13 +5,13 @@ open System.Reflection
 [<assembly: AssemblyTitleAttribute("FsUnit.NUnit")>]
 [<assembly: AssemblyProductAttribute("FsUnit")>]
 [<assembly: AssemblyDescriptionAttribute("FsUnit is a set of libraries that makes unit-testing with F# more enjoyable.")>]
-[<assembly: AssemblyVersionAttribute("5.6.1.0")>]
-[<assembly: AssemblyFileVersionAttribute("5.6.1.0")>]
+[<assembly: AssemblyVersionAttribute("6.0.0.0")>]
+[<assembly: AssemblyFileVersionAttribute("6.0.0.0")>]
 do ()
 
 module internal AssemblyVersionInformation =
     let [<Literal>] AssemblyTitle = "FsUnit.NUnit"
     let [<Literal>] AssemblyProduct = "FsUnit"
     let [<Literal>] AssemblyDescription = "FsUnit is a set of libraries that makes unit-testing with F# more enjoyable."
-    let [<Literal>] AssemblyVersion = "5.6.1.0"
-    let [<Literal>] AssemblyFileVersion = "5.6.1.0"
+    let [<Literal>] AssemblyVersion = "6.0.0.0"
+    let [<Literal>] AssemblyFileVersion = "6.0.0.0"
diff --git a/src/FsUnit.NUnit/FsUnit.NUnit.fsproj b/src/FsUnit.NUnit/FsUnit.NUnit.fsproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net6.0</TargetFrameworks>
+    <TargetFramework>net6.0</TargetFramework>
     <AssemblyName>FsUnit.NUnit</AssemblyName>
     <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>

diff --git a/src/FsUnit.NUnit/paket.template b/src/FsUnit.NUnit/paket.template
@@ -9,12 +9,14 @@ projectUrl
     https://github.com/fsprojects/FsUnit
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
+licenseExpression
+    MIT
 licenseUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
 requireLicenseAcceptance
     false
 copyright
-    Copyright 2012-2023
+    Copyright 2012-2024
 tags
     F# fsharp NUnit FsUnit
 summary

diff --git a/src/FsUnit.NUnit/sample.paket.template b/src/FsUnit.NUnit/sample.paket.template
@@ -9,12 +9,14 @@ projectUrl
     https://github.com/fsprojects/FsUnit
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
+licenseExpression
+    MIT
 licenseUrl
     https://github.com/fsprojects/FsUnit/blob/master/license.txt
 requireLicenseAcceptance
     false
 copyright
-    Copyright 2015-2023
+    Copyright 2015-2024
 tags
     F# fsharp NUnit FsUnit
 summary

diff --git a/src/FsUnit.Xunit/AssemblyInfo.fs b/src/FsUnit.Xunit/AssemblyInfo.fs
@@ -5,13 +5,13 @@ open System.Reflection
 [<assembly: AssemblyTitleAttribute("FsUnit.Xunit")>]
 [<assembly: AssemblyProductAttribute("FsUnit")>]
 [<assembly: AssemblyDescriptionAttribute("FsUnit is a set of libraries that makes unit-testing with F# more enjoyable.")>]
-[<assembly: AssemblyVersionAttribute("5.6.1.0")>]
-[<assembly: AssemblyFileVersionAttribute("5.6.1.0")>]
+[<assembly: AssemblyVersionAttribute("6.0.0.0")>]
+[<assembly: AssemblyFileVersionAttribute("6.0.0.0")>]
 do ()
 
 module internal AssemblyVersionInformation =
     let [<Literal>] AssemblyTitle = "FsUnit.Xunit"
     let [<Literal>] AssemblyProduct = "FsUnit"
     let [<Literal>] AssemblyDescription = "FsUnit is a set of libraries that makes unit-testing with F# more enjoyable."
-    let [<Literal>] AssemblyVersion = "5.6.1.0"
-    let [<Literal>] AssemblyFileVersion = "5.6.1.0"
+    let [<Literal>] AssemblyVersion = "6.0.0.0"
+    let [<Literal>] AssemblyFileVersion = "6.0.0.0"
diff --git a/src/FsUnit.Xunit/paket.template b/src/FsUnit.Xunit/paket.template
@@ -9,12 +9,14 @@ projectUrl
     https://github.com/fsprojects/FsUnit
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
+licenseExpression
+    MIT
 licenseUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
 requireLicenseAcceptance
     false
 copyright
-    Copyright 2012-2023
+    Copyright 2012-2024
 tags
     F# fsharp xUnit FsUnit
 summary

diff --git a/src/FsUnit.Xunit/sample.paket.template b/src/FsUnit.Xunit/sample.paket.template
@@ -9,12 +9,14 @@ projectUrl
     https://github.com/fsprojects/FsUnit
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
+licenseExpression
+    MIT
 licenseUrl
     https://github.com/fsprojects/FsUnit/blob/master/license.txt
 requireLicenseAcceptance
     false
 copyright
-    Copyright 2015-2023
+    Copyright 2015-2024
 tags
     F# fsharp xUnit FsUnit
 summary