Merge pull request #350 from JosephWoodward/ShouldBeTrueFalseDocs

Added ShouldBeTrue and ShouldBeFalse docs

docs/assertions/shouldBeTrueFalse.rst

@@ -0,0 +1,23 @@
+ShouldBeTrue/False
+========
+
+``ShouldBeTrue`` and ``ShouldBeFalse`` work on boolean values.
+
+ShouldBeTrue
+------------
+.. literalinclude:: /../src/DocumentationExamples/CodeExamples/ShouldBeTrueFalseExamples/ShouldBeTrue.codeSample.approved.txt
+	:language: c#
+
+**Exception**
+
+.. literalinclude:: /../src/DocumentationExamples/CodeExamples/ShouldBeTrueFalseExamples/ShouldBeTrue.exceptionText.approved.txt
+
+ShouldBeFalse
+------------
+
+.. literalinclude:: /../src/DocumentationExamples/CodeExamples/ShouldBeTrueFalseExamples/ShouldBeFalse.codeSample.approved.txt
+	:language: c#
+
+**Exception**
+
+.. literalinclude:: /../src/DocumentationExamples/CodeExamples/ShouldBeTrueFalseExamples/ShouldBeFalse.exceptionText.approved.txt

docs/index.rst

@@ -57,6 +57,7 @@ Shouldly has plenty of different assertions, have a look under the assertions fo
    assertions/shouldBe
    assertions/shouldNotBe
    assertions/shouldMatchApproved
+   assertions/shouldBeTrueFalse
    exampleClasses
    contributing
    configuration

src/DocumentationExamples/CodeExamples/ShouldBeTrueFalseExamples/ShouldBeFalse.codeSample.approved.txt

@@ -0,0 +1,2 @@
+bool myValue = true;
+myValue.ShouldBeFalse();

src/DocumentationExamples/CodeExamples/ShouldBeTrueFalseExamples/ShouldBeFalse.exceptionText.approved.txt

@@ -0,0 +1,5 @@
+myValue
+    should be
+False
+    but was
+True

src/DocumentationExamples/CodeExamples/ShouldBeTrueFalseExamples/ShouldBeTrue.codeSample.approved.txt

@@ -0,0 +1,2 @@
+bool myValue = false;
+myValue.ShouldBeTrue();

src/DocumentationExamples/CodeExamples/ShouldBeTrueFalseExamples/ShouldBeTrue.exceptionText.approved.txt

@@ -0,0 +1,5 @@
+myValue
+    should be
+True
+    but was
+False

src/DocumentationExamples/DocumentationExamples.csproj

@@ -82,6 +82,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="DocExampleWriter.cs" />
+    <Compile Include="ShouldBeTrueFalseExamples.cs" />
     <Compile Include="ShouldMatchApprovedExamples.cs" />
     <Compile Include="ShouldNotBeExamples.cs" />
     <Compile Include="ShouldBeExamples.cs" />

src/DocumentationExamples/ShouldBeTrueFalseExamples.cs

@@ -0,0 +1,37 @@
+using Shouldly;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace DocumentationExamples
+{
+    public class ShouldBeTrueFalseExamples
+    {
+        readonly ITestOutputHelper _testOutputHelper;
+
+        public ShouldBeTrueFalseExamples(ITestOutputHelper testOutputHelper)
+        {
+            _testOutputHelper = testOutputHelper;
+        }
+
+        [Fact]
+        public void ShouldBeTrue()
+        {
+            DocExampleWriter.Document(() =>
+            {
+                bool myValue = false;
+                myValue.ShouldBeTrue();
+            }, _testOutputHelper);
+        }
+
+        [Fact]
+        public void ShouldBeFalse()
+        {
+            DocExampleWriter.Document(() =>
+            {
+                bool myValue = true;
+                myValue.ShouldBeFalse();
+            }, _testOutputHelper);
+        }
+
+    }
+}