test: Adjust tests to changed behavior of MkDocsTestFormatter

ap0llo · Mar 5, 2020 · 80a7914 · 80a7914
1 parent 939ba14
commit 80a7914
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/docs/apireference/Grynwald/MarkdownGenerator/MkDocsTextFormatter/index.md b/docs/apireference/Grynwald/MarkdownGenerator/MkDocsTextFormatter/index.md
@@ -20,6 +20,7 @@ This implementation works largely the same as [DefaultTextFormatter](../DefaultT
 
 - `<` is escaped as `&lt;`.
 - `>` is escaped as `&gt;`.
+- `/` is not escaped.
 
 ## Fields
 

diff --git a/src/MarkdownGenerator.Test/_Model/_Options/MkDocsTextFormatterTest.cs b/src/MarkdownGenerator.Test/_Model/_Options/MkDocsTextFormatterTest.cs
@@ -7,7 +7,6 @@ public class MkDocsTextFormatterTest
         [Theory]
         [InlineData("<", "&lt;")]
         [InlineData(">", "&gt;")]
-        [InlineData("/", "\\/")]
         [InlineData("\\", "\\\\")]
         [InlineData("*", "\\*")]
         [InlineData("_", "\\_")]
@@ -31,5 +30,21 @@ public void Escape_text_escapes_expected_characters(string input, string expecte
             // ASSERT
             Assert.Equal(expected, actual);
         }
+
+
+
+        [Theory]
+        [InlineData("/")] // slashes must not escaped for MkDocs / Python Markdown
+        public void Escape_does_not_escape_non_escapable_characters(string input)
+        {// ARRANGE
+            var sut = MkDocsTextFormatter.Instance;
+
+            // ACT
+            var escaped = sut.EscapeText(input);
+
+            // ASSERT
+            Assert.Equal(input, escaped);
+        }
+
     }
 }
diff --git a/src/MarkdownGenerator/_Model/_Options/MkDocsTextFormatter.cs b/src/MarkdownGenerator/_Model/_Options/MkDocsTextFormatter.cs
@@ -12,6 +12,7 @@ namespace Grynwald.MarkdownGenerator
     /// <list type="bullet">
     ///     <item><description><c>&lt;</c> is escaped as <c>&amp;lt;</c>.</description></item>
     ///     <item><description><c>&gt;</c> is escaped as <c>&amp;gt;</c>.</description></item>
+    ///     <item><description><c>/</c> is not escaped.</description></item>
     /// </list>
     /// </remarks>
     public sealed class MkDocsTextFormatter : ITextFormatter