Merge pull request #351 from JosephWoodward/ShouldBeNullNotNullDocs

Added ShouldBeNullNotNull docs

docs/assertions/shouldBeNullShouldNotBeNull.rst

@@ -0,0 +1,24 @@
+ShouldBeNull/NotBeNull
+===========
+
+``ShouldBeNull`` and ``ShouldNotBeNull`` allow you to check whether or not a type's reference is null.
+
+ShouldBeNull
+-------
+
+.. literalinclude:: /../src/DocumentationExamples/CodeExamples/ShouldBeNullNotNullExamples/ShouldBeNull.codeSample.approved.txt
+	:language: c#
+
+**Exception**
+
+.. literalinclude:: /../src/DocumentationExamples/CodeExamples/ShouldBeNullNotNullExamples/ShouldBeNull.exceptionText.approved.txt
+
+ShouldNotBeNull
+-------
+
+.. literalinclude:: /../src/DocumentationExamples/CodeExamples/ShouldBeNullNotNullExamples/ShouldNotBeNull.codeSample.approved.txt
+	:language: c#
+
+**Exception**
+
+.. literalinclude:: /../src/DocumentationExamples/CodeExamples/ShouldBeNullNotNullExamples/ShouldNotBeNull.exceptionText.approved.txt

docs/index.rst

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

src/DocumentationExamples/CodeExamples/ShouldBeNullNotNullExamples/ShouldBeNull.codeSample.approved.txt

@@ -0,0 +1,2 @@
+string myRef = "Hello World";
+myRef.ShouldBeNull();

src/DocumentationExamples/CodeExamples/ShouldBeNullNotNullExamples/ShouldBeNull.exceptionText.approved.txt

@@ -0,0 +1,3 @@
+myRef
+    should be null but was
+"Hello World"

src/DocumentationExamples/CodeExamples/ShouldBeNullNotNullExamples/ShouldNotBeNull.codeSample.approved.txt

@@ -0,0 +1,2 @@
+string myRef = null;
+myRef.ShouldNotBeNull();

src/DocumentationExamples/CodeExamples/ShouldBeNullNotNullExamples/ShouldNotBeNull.exceptionText.approved.txt

@@ -0,0 +1,2 @@
+myRef
+    should not be null but was

src/DocumentationExamples/DocumentationExamples.csproj

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

src/DocumentationExamples/ShouldBeNullNotNullExamples.cs

@@ -0,0 +1,36 @@
+using Shouldly;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace DocumentationExamples
+{
+    public class ShouldBeNullNotNullExamples
+    {
+        readonly ITestOutputHelper _testOutputHelper;
+
+        public ShouldBeNullNotNullExamples(ITestOutputHelper testOutputHelper)
+        {
+            _testOutputHelper = testOutputHelper;
+        }
+
+        [Fact]
+        public void ShouldBeNull()
+        {
+            DocExampleWriter.Document(() =>
+            {
+                string myRef = "Hello World";
+                myRef.ShouldBeNull();
+            }, _testOutputHelper);
+        }
+
+        [Fact]
+        public void ShouldNotBeNull()
+        {
+            DocExampleWriter.Document(() =>
+            {
+                string myRef = null;
+                myRef.ShouldNotBeNull();
+            }, _testOutputHelper);
+        }
+    }
+}