@zzzen/pyright-internal 1.2.0-dev.20240609 → 1.2.0-dev.20240616

package/dist/tests/docStringConversion.test.js

@@ -7,59 +7,61 @@
  * Tests for the Python doc string to markdown converter.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.docStringTests = void 0;
 const assert = require("assert");
-const docStringConversion_1 = require("../analyzer/docStringConversion");
+const docStringService_1 = require("../common/docStringService");
 // For substitution in the test data strings
 // Produces more readable test data than escaping the back ticks
 const singleTick = '`';
 const doubleTick = '``';
 const tripleTick = '```';
 const tripleTilda = '~~~';
-test('PlaintextIndention', () => {
-    const all = [
-        ['A\nB', 'A\nB'],
-        ['A\n\nB', 'A\n\nB'],
-        ['A\n    B', 'A\nB'],
-        ['    A\n    B', 'A\nB'],
-        ['\nA\n    B', 'A\n    B'],
-        ['\n    A\n    B', 'A\nB'],
-        ['\nA\nB\n', 'A\nB'],
-        ['  \n\nA \n    \nB  \n    ', 'A\n\nB'],
-    ];
-    all.forEach((v) => _testConvertToPlainText(v[0], v[1]));
-});
-test('MarkdownIndention', () => {
-    const all = [
-        ['A\nB', 'A\nB'],
-        ['A\n\nB', 'A\n\nB'],
-        ['A\n    B', 'A\nB'],
-        ['    A\n    B', 'A\nB'],
-        ['\nA\n    B', 'A  \n    B'],
-        ['\n    A\n    B', 'A\nB'],
-        ['\nA\nB\n', 'A\nB'],
-        ['  \n\nA \n    \nB  \n    ', 'A\n\nB'],
-    ];
-    all.forEach((v) => _testConvertToMarkdown(v[0], v[1]));
-});
-test('NormalText', () => {
-    const docstring = `This is just some normal text
+function docStringTests(docStringService = new docStringService_1.PyrightDocStringService()) {
+    test('PlaintextIndention', () => {
+        const all = [
+            ['A\nB', 'A\nB'],
+            ['A\n\nB', 'A\n\nB'],
+            ['A\n    B', 'A\nB'],
+            ['    A\n    B', 'A\nB'],
+            ['\nA\n    B', 'A\n    B'],
+            ['\n    A\n    B', 'A\nB'],
+            ['\nA\nB\n', 'A\nB'],
+            ['  \n\nA \n    \nB  \n    ', 'A\n\nB'],
+        ];
+        all.forEach((v) => _testConvertToPlainText(v[0], v[1]));
+    });
+    test('MarkdownIndention', () => {
+        const all = [
+            ['A\nB', 'A\nB'],
+            ['A\n\nB', 'A\n\nB'],
+            ['A\n    B', 'A\nB'],
+            ['    A\n    B', 'A\nB'],
+            ['\nA\n    B', 'A  \n    B'],
+            ['\n    A\n    B', 'A\nB'],
+            ['\nA\nB\n', 'A\nB'],
+            ['  \n\nA \n    \nB  \n    ', 'A\n\nB'],
+        ];
+        all.forEach((v) => _testConvertToMarkdown(v[0], v[1]));
+    });
+    test('NormalText', () => {
+        const docstring = `This is just some normal text
 that extends over multiple lines. This will appear
 as-is without modification.
 `;
-    const markdown = `This is just some normal text
+        const markdown = `This is just some normal text
 that extends over multiple lines. This will appear
 as-is without modification.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('InlineLiterals', () => {
-    const docstring = 'This paragraph talks about ``foo``\n' +
-        'which is related to :something:`bar`, and probably `qux`:something_else:.\n';
-    const markdown = 'This paragraph talks about `foo`  \n' + 'which is related to `bar`, and probably `qux`.\n';
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('Headings', () => {
-    const docstring = `Heading 1
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('InlineLiterals', () => {
+        const docstring = 'This paragraph talks about ``foo``\n' +
+            'which is related to :something:`bar`, and probably `qux`:something_else:.\n';
+        const markdown = 'This paragraph talks about `foo`  \n' + 'which is related to `bar`, and probably `qux`.\n';
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('Headings', () => {
+        const docstring = `Heading 1
 =========
 
 Heading 2
@@ -71,7 +73,7 @@ Heading 3
 Heading 4
 +++++++++
 `;
-    const markdown = `Heading 1
+        const markdown = `Heading 1
 =========
 
 Heading 2
@@ -83,40 +85,40 @@ Heading 3
 Heading 4
 ---------
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('AsterisksAtStartOfArgs', () => {
-    const docstring = `Foo:
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('AsterisksAtStartOfArgs', () => {
+        const docstring = `Foo:
 
     Args:
         foo (Foo): Foo!
         *args: These are positional args.
         **kwargs: These are named args.
 `;
-    const markdown = `Foo:
+        const markdown = `Foo:
 
 Args:  
     foo (Foo): Foo!  
     \\*args: These are positional args.  
     \\*\\*kwargs: These are named args.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('CopyrightAndLicense', () => {
-    const docstring = `This is a test.
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('CopyrightAndLicense', () => {
+        const docstring = `This is a test.
 
 :copyright: Fake Name
 :license: ABCv123
 `;
-    const markdown = `This is a test.
+        const markdown = `This is a test.
 
 :copyright: Fake Name  
 :license: ABCv123
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('CommonRestFieldLists', () => {
-    const docstring = `This function does something.
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('CommonRestFieldLists', () => {
+        const docstring = `This function does something.
 
 :param foo: This is a description of the foo parameter
     which does something interesting.
@@ -127,7 +129,7 @@ test('CommonRestFieldLists', () => {
 :rtype: Something
 :raises ValueError: If something goes wrong.
 `;
-    const markdown = `This function does something.
+        const markdown = `This function does something.
 
 :param foo: This is a description of the foo parameter  
     which does something interesting.  
@@ -138,47 +140,47 @@ test('CommonRestFieldLists', () => {
 :rtype: Something  
 :raises ValueError: If something goes wrong.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('Doctest', () => {
-    const docstring = `This is a doctest:
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('Doctest', () => {
+        const docstring = `This is a doctest:
 
 >>> print('foo')
 foo
 `;
-    const markdown = `This is a doctest:
+        const markdown = `This is a doctest:
 
 ${tripleTick}
 >>> print('foo')
 foo
 ${tripleTick}
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('DoctestIndented', () => {
-    const docstring = `This is a doctest:
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('DoctestIndented', () => {
+        const docstring = `This is a doctest:
 
     >>> print('foo')
     foo
 `;
-    const markdown = `This is a doctest:
+        const markdown = `This is a doctest:
 
 ${tripleTick}
 >>> print('foo')
 foo
 ${tripleTick}
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('DoctestTextAfter', () => {
-    const docstring = `This is a doctest:
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('DoctestTextAfter', () => {
+        const docstring = `This is a doctest:
 
 >>> print('foo')
 foo
 
 This text comes after.
 `;
-    const markdown = `This is a doctest:
+        const markdown = `This is a doctest:
 
 ${tripleTick}
 >>> print('foo')
@@ -187,16 +189,16 @@ ${tripleTick}
 
 This text comes after.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('DoctestIndentedTextAfter', () => {
-    const docstring = `This is a doctest:
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('DoctestIndentedTextAfter', () => {
+        const docstring = `This is a doctest:
 
     >>> print('foo')
     foo
   This line has a different indent.
 `;
-    const markdown = `This is a doctest:
+        const markdown = `This is a doctest:
 
 ${tripleTick}
 >>> print('foo')
@@ -205,10 +207,10 @@ ${tripleTick}
 
 This line has a different indent.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('MarkdownStyleBacktickBlock', () => {
-    const docstring = `Backtick block:
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('MarkdownStyleBacktickBlock', () => {
+        const docstring = `Backtick block:
 
 ${tripleTick}
 print(foo_bar)
@@ -219,7 +221,7 @@ ${tripleTick}
 
 And some text after.
 `;
-    const markdown = `Backtick block:
+        const markdown = `Backtick block:
 
 ${tripleTick}
 print(foo_bar)
@@ -230,10 +232,10 @@ ${tripleTick}
 
 And some text after.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('MarkdownStyleTildaBlock', () => {
-    const docstring = `Backtick block:
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('MarkdownStyleTildaBlock', () => {
+        const docstring = `Backtick block:
 
 ${tripleTilda}
 print(foo_bar)
@@ -244,7 +246,7 @@ ${tripleTilda}
 
 And some text after.
 `;
-    const markdown = `Backtick block:
+        const markdown = `Backtick block:
 
 ${tripleTilda}
 print(foo_bar)
@@ -255,10 +257,10 @@ ${tripleTilda}
 
 And some text after.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('RestLiteralBlock', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('RestLiteralBlock', () => {
+        const docstring = `
 Take a look at this code::
 
     if foo:
@@ -268,7 +270,7 @@ Take a look at this code::
 
 This text comes after.
 `;
-    const markdown = `Take a look at this code:
+        const markdown = `Take a look at this code:
 
 ${tripleTick}
     if foo:
@@ -279,10 +281,10 @@ ${tripleTick}
 
 This text comes after.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('RestLiteralBlockEmptyDoubleColonLine', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('RestLiteralBlockEmptyDoubleColonLine', () => {
+        const docstring = `
 ::
 
     if foo:
@@ -290,17 +292,17 @@ test('RestLiteralBlockEmptyDoubleColonLine', () => {
     else:
         print('not foo!')
 `;
-    const markdown = `${tripleTick}
+        const markdown = `${tripleTick}
     if foo:
         print(foo)
     else:
         print('not foo!')
 ${tripleTick}
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('RestLiteralBlockExtraSpace', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('RestLiteralBlockExtraSpace', () => {
+        const docstring = `
 Take a look at this code::
 
 
@@ -313,7 +315,7 @@ Take a look at this code::
 
 This text comes after.
 `;
-    const markdown = `Take a look at this code:
+        const markdown = `Take a look at this code:
 
 ${tripleTick}
     if foo:
@@ -324,17 +326,17 @@ ${tripleTick}
 
 This text comes after.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('RestLiteralBlockNoIndentOneLiner', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('RestLiteralBlockNoIndentOneLiner', () => {
+        const docstring = `
 The next code is a one-liner::
 
 print(a + foo + 123)
 
 And now it's text.
 `;
-    const markdown = `The next code is a one-liner:
+        const markdown = `The next code is a one-liner:
 
 ${tripleTick}
 print(a + foo + 123)
@@ -342,10 +344,10 @@ ${tripleTick}
 
 And now it's text.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('DirectiveRemoval', () => {
-    const docstring = `This is a test.
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('DirectiveRemoval', () => {
+        const docstring = `This is a test.
 
 .. ignoreme:: example
 
@@ -361,22 +363,22 @@ This text is in-between.
 
 This text comes after.
 `;
-    const markdown = `This is a test.
+        const markdown = `This is a test.
 
 This text is in-between.
 
 This text comes after.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('ClassDirective', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('ClassDirective', () => {
+        const docstring = `
 .. class:: FooBar()
     This is a description of ${doubleTick}FooBar${doubleTick}.
 
 ${doubleTick}FooBar${doubleTick} is interesting.
 `;
-    const markdown = `${tripleTick}
+        const markdown = `${tripleTick}
 FooBar()
 ${tripleTick}
 
@@ -384,10 +386,10 @@ This is a description of ${singleTick}FooBar${singleTick}.
 
 ${singleTick}FooBar${singleTick} is interesting.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('CodeBlockDirective', () => {
-    const docstring = `Take a look at this 
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('CodeBlockDirective', () => {
+        const docstring = `Take a look at this 
     .. code-block:: Python
 
     if foo:
@@ -397,7 +399,7 @@ test('CodeBlockDirective', () => {
 
 This text comes after.
 `;
-    const markdown = `Take a look at this
+        const markdown = `Take a look at this
 ${tripleTick}
 
     if foo:
@@ -407,70 +409,70 @@ ${tripleTick}
 ${tripleTick}
 
 This text comes after.`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('UnfinishedBacktickBlock', () => {
-    const docstring = '```\nsomething\n';
-    const markdown = '```\nsomething\n```\n';
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('UnfinishedTildaBlock', () => {
-    const docstring = '~~~\nsomething\n';
-    const markdown = '~~~\nsomething\n~~~\n';
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('UnfinishedInlineLiteral', () => {
-    const docstring = '`oops\n';
-    const markdown = '`oops`';
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('DashList', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('UnfinishedBacktickBlock', () => {
+        const docstring = '```\nsomething\n';
+        const markdown = '```\nsomething\n```\n';
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('UnfinishedTildaBlock', () => {
+        const docstring = '~~~\nsomething\n';
+        const markdown = '~~~\nsomething\n~~~\n';
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('UnfinishedInlineLiteral', () => {
+        const docstring = '`oops\n';
+        const markdown = '`oops`';
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('DashList', () => {
+        const docstring = `
 This is a list:
   - Item 1
   - Item 2
 `;
-    const markdown = `This is a list:
+        const markdown = `This is a list:
   - Item 1
   - Item 2
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('AsteriskList', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('AsteriskList', () => {
+        const docstring = `
 This is a list:
   * Item 1
   * Item 2
 `;
-    const markdown = `This is a list:
+        const markdown = `This is a list:
   * Item 1
   * Item 2
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('SquareBrackets', () => {
-    const docstring = 'Optional[List[str]]';
-    const markdown = 'Optional\\[List\\[str\\]\\]';
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('ListDashMultiline', () => {
-    const docstring = `Keyword Arguments:
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('SquareBrackets', () => {
+        const docstring = 'Optional[List[str]]';
+        const markdown = 'Optional\\[List\\[str\\]\\]';
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('ListDashMultiline', () => {
+        const docstring = `Keyword Arguments:
 
     - option_strings -- A list of command-line option strings which
         should be associated with this action.
 
     - dest -- The name of the attribute to hold the created object(s)
 `;
-    const markdown = `Keyword Arguments:
+        const markdown = `Keyword Arguments:
 
 - option\\_strings -- A list of command-line option strings which
 should be associated with this action.
 
 - dest -- The name of the attribute to hold the created object(s)`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('HalfIndentOnLeadingDash', () => {
-    const docstring = `Dash List
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('HalfIndentOnLeadingDash', () => {
+        const docstring = `Dash List
 - foo
     - foo
 - bar
@@ -478,17 +480,17 @@ test('HalfIndentOnLeadingDash', () => {
 - qux
     - aaa
     `;
-    const markdown = `Dash List
+        const markdown = `Dash List
 - foo
   - foo
 - bar
   - baz
 - qux
   - aaa`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('AsteriskMultilineList', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('AsteriskMultilineList', () => {
+        const docstring = `
 This is a list:
     * this is a long, multi-line paragraph. It
       seems to go on and on.
@@ -496,30 +498,30 @@ This is a list:
     * this is a long, multi-line paragraph. It
       seems to go on and on.
 `;
-    const markdown = `This is a list:
+        const markdown = `This is a list:
   * this is a long, multi-line paragraph. It
 seems to go on and on.
 
   * this is a long, multi-line paragraph. It
 seems to go on and on.
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('ListAsteriskAddLeadingSpace', () => {
-    const docstring = `Title
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('ListAsteriskAddLeadingSpace', () => {
+        const docstring = `Title
 * First line bullet, no leading space
   with second line.
 * Second line bullet, no leading space
   with second line.`;
-    const markdown = `Title
+        const markdown = `Title
  * First line bullet, no leading space
 with second line.
  * Second line bullet, no leading space
 with second line.`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('PandasReadCsvListIndent', () => {
-    const docstring = `Title
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('PandasReadCsvListIndent', () => {
+        const docstring = `Title
 keep_default_na : bool, default True
     Whether or not to include the default NaN values when parsing the data.
 
@@ -527,7 +529,7 @@ keep_default_na : bool, default True
         is appended to the default NaN values used for parsing.   
 
 na_filter : bool, default True`;
-    const markdown = `Title  
+        const markdown = `Title  
 keep\\_default\\_na : bool, default True  
     Whether or not to include the default NaN values when parsing the data.
 
@@ -535,52 +537,52 @@ keep\\_default\\_na : bool, default True
 is appended to the default NaN values used for parsing.
 
 na\\_filter : bool, default True`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('FieldListEpyText', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('FieldListEpyText', () => {
+        const docstring = `
     1. Epytext:
          @param param1: description`;
-    const markdown = `
+        const markdown = `
 1. Epytext:  
      @param param1: description`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('FieldListRest', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('FieldListRest', () => {
+        const docstring = `
     2. reST:
          :param param1: description`;
-    const markdown = `
+        const markdown = `
 2. reST:  
      :param param1: description`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('FieldListGoogleV1', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('FieldListGoogleV1', () => {
+        const docstring = `
     3. Google (variant 1):
          Args:
              param1: description`;
-    const markdown = `
+        const markdown = `
 3. Google (variant 1):  
      Args:  
          param1: description`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('FieldListGoogleV2', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('FieldListGoogleV2', () => {
+        const docstring = `
     4. Google (variant 2):
          Args:
              param1 (type): description
              param2 (type): description`;
-    const markdown = `
+        const markdown = `
 4. Google (variant 2):  
      Args:  
          param1 (type): description  
          param2 (type): description`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('Googlewithreturntypes', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('Googlewithreturntypes', () => {
+        const docstring = `
     Example function with types documented in the docstring.
 
     \`PEP 484\`_ type annotations are supported. If attribute, parameter, and
@@ -596,7 +598,7 @@ test('Googlewithreturntypes', () => {
 
     .. _PEP 484:
         https://www.python.org/dev/peps/pep-0484/`;
-    const markdown = `
+        const markdown = `
 Example function with types documented in the docstring.
 
 \`PEP 484\`\\_ type annotations are supported. If attribute, parameter, and
@@ -609,10 +611,10 @@ Args:
 
 Returns:  
     bool: The return value. True for success, False otherwise.`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('GoogleWithComplexTypes', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('GoogleWithComplexTypes', () => {
+        const docstring = `
     Example function with types documented in the docstring.
 
     Args:
@@ -622,7 +624,7 @@ test('GoogleWithComplexTypes', () => {
     Returns:
         bool: The return value. True for success, False otherwise.
 `;
-    const markdown = `
+        const markdown = `
 Example function with types documented in the docstring.
 
 Args:  
@@ -631,21 +633,21 @@ Args:
 
 Returns:  
     bool: The return value. True for success, False otherwise.`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('FieldListDontAddLineBreaksToHeaders', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('FieldListDontAddLineBreaksToHeaders', () => {
+        const docstring = `
     Parameters
     ----------
     ThisIsAFieldAfterAHeader : str`;
-    const markdown = `
+        const markdown = `
 Parameters
 ----------
 ThisIsAFieldAfterAHeader : str`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('EpyDocCv2Imread', () => {
-    const docstring = `imread(filename[, flags]) -> retval
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('EpyDocCv2Imread', () => {
+        const docstring = `imread(filename[, flags]) -> retval
 .   @brief Loads an image from a file.
 .   @anchor imread
 .   
@@ -656,7 +658,7 @@ test('EpyDocCv2Imread', () => {
 .   
 .   -   Windows bitmaps - \\*.bmp, \\*.dib (always supported)
 .   -   JPEG files - \\*.jpeg, \\*.jpg, \\*.jpe (see the *Note* section)`;
-    const markdown = `imread(filename\\[, flags\\]) -> retval
+        const markdown = `imread(filename\\[, flags\\]) -> retval
 
 @brief Loads an image from a file.
 
@@ -669,10 +671,10 @@ Currently, the following file formats are supported:
 
 -   Windows bitmaps - \\*.bmp, \\*.dib (always supported)
 -   JPEG files - \\*.jpeg, \\*.jpg, \\*.jpe (see the \\*Note\\* section)`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('Non EpyDocCv2Imread', () => {
-    const docstring = `imread(filename[, flags]) -> retval
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('Non EpyDocCv2Imread', () => {
+        const docstring = `imread(filename[, flags]) -> retval
   .   @brief Loads an image from a file.
   .   @anchor imread
   .   
@@ -683,7 +685,7 @@ test('Non EpyDocCv2Imread', () => {
   .   
   .   -   Windows bitmaps - \\*.bmp, \\*.dib (always supported)
   .   -   JPEG files - \\*.jpeg, \\*.jpg, \\*.jpe (see the *Note* section)`;
-    const markdown = `imread(filename\\[, flags\\]) -> retval
+        const markdown = `imread(filename\\[, flags\\]) -> retval
 .   @brief Loads an image from a file.
 .   @anchor imread
 .
@@ -694,10 +696,10 @@ test('Non EpyDocCv2Imread', () => {
 .
 .   -   Windows bitmaps - \\*.bmp, \\*.dib (always supported)
 .   -   JPEG files - \\*.jpeg, \\*.jpg, \\*.jpe (see the \\*Note\\* section)`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('EpyDocTest', () => {
-    const docstring = `Return the x intercept of the line M{y=m*x+b}.  The X{x intercept}
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('EpyDocTest', () => {
+        const docstring = `Return the x intercept of the line M{y=m*x+b}.  The X{x intercept}
 of a line is the point at which it crosses the x axis (M{y=0}).
 
 This function can be used in conjuction with L{z_transform} to
@@ -710,7 +712,7 @@ find an arbitrary function's zeros.
             line is the point at which it crosses the y axis (M{x=0}).
 @rtype:   number
 @return:  the x intercept of the line M{y=m*x+b}.`;
-    const markdown = `Return the x intercept of the line M{y=m\\*x+b}.  The X{x intercept}
+        const markdown = `Return the x intercept of the line M{y=m\\*x+b}.  The X{x intercept}
 of a line is the point at which it crosses the x axis (M{y=0}).
 
 This function can be used in conjuction with L{z\\_transform} to
@@ -728,20 +730,20 @@ find an arbitrary function's zeros.
 @rtype:   number
 
 @return:  the x intercept of the line M{y=m\\*x+b}.`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('DontEscapeHtmlTagsInsideCodeBlocks', () => {
-    const docstring = 'hello  `<code>`';
-    const markdown = 'hello  `<code>`';
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('EscapeHtmlTagsOutsideCodeBlocks', () => {
-    const docstring = 'hello  <noncode>';
-    const markdown = 'hello  &lt;noncode&gt;';
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('IndentedCodeBlock', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('DontEscapeHtmlTagsInsideCodeBlocks', () => {
+        const docstring = 'hello  `<code>`';
+        const markdown = 'hello  `<code>`';
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('EscapeHtmlTagsOutsideCodeBlocks', () => {
+        const docstring = 'hello  <noncode>';
+        const markdown = 'hello  &lt;noncode&gt;';
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('IndentedCodeBlock', () => {
+        const docstring = `
 Expected:
     ${tripleTick}python
     def some_fn():
@@ -751,7 +753,7 @@ Expected:
         """
     ${tripleTick}
 `;
-    const markdown = `
+        const markdown = `
 Expected:
 ${tripleTick}python
     def some_fn():
@@ -761,10 +763,10 @@ ${tripleTick}python
         """
 ${tripleTick}
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('IndentedCodeBlockTilda', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('IndentedCodeBlockTilda', () => {
+        const docstring = `
 Expected:
     ${tripleTilda}python
     def some_fn():
@@ -774,7 +776,7 @@ Expected:
         """
     ${tripleTilda}
 `;
-    const markdown = `
+        const markdown = `
 Expected:
 ${tripleTilda}python
     def some_fn():
@@ -784,10 +786,10 @@ ${tripleTilda}python
         """
 ${tripleTilda}
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('MixedCodeBlockBacktick', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('MixedCodeBlockBacktick', () => {
+        const docstring = `
 Expected:
     ${tripleTick}python
     def some_fn():
@@ -805,7 +807,7 @@ Expected:
         """
     ${tripleTilda}
 `;
-    const markdown = `
+        const markdown = `
 Expected:
 ${tripleTick}python
     def some_fn():
@@ -824,27 +826,27 @@ ${tripleTilda}python
         """
 ${tripleTilda}
 `;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('RestTableWithHeader', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('RestTableWithHeader', () => {
+        const docstring = `
 =============== =========================================================
 Generator
 --------------- ---------------------------------------------------------
 Generator       Class implementing all of the random number distributions
 default_rng     Default constructor for \`\`Generator\`\`
 =============== =========================================================`;
-    const markdown = `
+        const markdown = `
 |Generator | |
 |---------------|---------------------------------------------------------|
 |Generator       |Class implementing all of the random number distributions|
 |default_rng     |Default constructor for \`\`Generator\`\`|
 
 <br/>`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('RestTablesMultilineHeader', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('RestTablesMultilineHeader', () => {
+        const docstring = `
 ==================== =========================================================
 Compatibility
 functions - removed
@@ -852,16 +854,16 @@ in the new API
 -------------------- ---------------------------------------------------------
 rand                 Uniformly distributed values.
 ==================== =========================================================`;
-    const markdown = `
+        const markdown = `
 |Compatibility <br>functions - removed <br>in the new API | <br> <br> |
 |--------------------|---------------------------------------------------------|
 |rand                 |Uniformly distributed values.|
 
 <br/>`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('RestTableSimple', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('RestTableSimple', () => {
+        const docstring = `
 ============================== =====================================
 Scalar Type                    Array Type
 ============================== =====================================
@@ -869,16 +871,16 @@ Scalar Type                    Array Type
 :class:\`pandas.Period\`         :class:\`pandas.arrays.PeriodArray\`
 ============================== =====================================
     `;
-    const markdown = `|Scalar Type                     |Array Type |
+        const markdown = `|Scalar Type                     |Array Type |
 |------------------------------|-------------------------------------|
 |:class:\`pandas.Interval\`       |:class:\`pandas.arrays.IntervalArray\`|
 |:class:\`pandas.Period\`         |:class:\`pandas.arrays.PeriodArray\`|
 
 <br/>`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test('ReSTTableIndented', () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test('ReSTTableIndented', () => {
+        const docstring = `
     data :
 
     dtype : str, np.dtype, or ExtensionDtype, optional
@@ -889,7 +891,7 @@ test('ReSTTableIndented', () => {
         :class:\`pandas.Interval\`     :class:\`pandas.arrays.IntervalArray\`
         :class:\`pandas.Period\`       :class:\`pandas.arrays.PeriodArray\`
         ============================== =====================================`;
-    const markdown = `
+        const markdown = `
 data :
 
 dtype : str, np.dtype, or ExtensionDtype, optional
@@ -900,31 +902,31 @@ dtype : str, np.dtype, or ExtensionDtype, optional
 |    :class:\`pandas.Period\`     |  :class:\`pandas.arrays.PeriodArray\`|
 
 <br/>`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-test(`OddnumberOfColons`, () => {
-    const docstring = `
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    test(`OddnumberOfColons`, () => {
+        const docstring = `
     @param 'original:str' or 'original:list': original string to compare
     @param 'new:str': the new string to compare
     @return 'int': levenshtein difference
     @return 'list': levenshtein difference if list
     `;
-    const markdown = `@param 'original:str' or 'original:list': original string to compare\n\n@param 'new:str': the new string to compare\n\n@return 'int': levenshtein difference\n\n@return 'list': levenshtein difference if list`;
-    _testConvertToMarkdown(docstring, markdown);
-});
-function _testConvertToMarkdown(docstring, expectedMarkdown) {
-    const actualMarkdown = (0, docStringConversion_1.convertDocStringToMarkdown)(docstring);
-    assert.equal(_normalizeLineEndings(actualMarkdown).trim(), _normalizeLineEndings(expectedMarkdown).trim());
-}
-function _testConvertToPlainText(docstring, expectedPlainText) {
-    const actualMarkdown = (0, docStringConversion_1.convertDocStringToPlainText)(docstring);
-    assert.equal(_normalizeLineEndings(actualMarkdown).trim(), _normalizeLineEndings(expectedPlainText).trim());
-}
-function _normalizeLineEndings(text) {
-    return text.split(/\r?\n/).join('\n');
-}
-test('RPYCLiteralBlockTransition', () => {
-    const docstring = `
+        const markdown = `@param 'original:str' or 'original:list': original string to compare\n\n@param 'new:str': the new string to compare\n\n@return 'int': levenshtein difference\n\n@return 'list': levenshtein difference if list`;
+        _testConvertToMarkdown(docstring, markdown);
+    });
+    function _testConvertToMarkdown(docstring, expectedMarkdown) {
+        const actualMarkdown = docStringService.convertDocStringToMarkdown(docstring);
+        assert.equal(_normalizeLineEndings(actualMarkdown).trim(), _normalizeLineEndings(expectedMarkdown).trim());
+    }
+    function _testConvertToPlainText(docstring, expectedPlainText) {
+        const actualMarkdown = docStringService.convertDocStringToPlainText(docstring);
+        assert.equal(_normalizeLineEndings(actualMarkdown).trim(), _normalizeLineEndings(expectedPlainText).trim());
+    }
+    function _normalizeLineEndings(text) {
+        return text.split(/\r?\n/).join('\n');
+    }
+    test('RPYCLiteralBlockTransition', () => {
+        const docstring = `
 ::
 
          #####    #####             ####
@@ -939,7 +941,7 @@ test('RPYCLiteralBlockTransition', () => {
 
 Remote Python Call (RPyC)
 `;
-    const markdown = `
+        const markdown = `
 
 ${tripleTick}
          #####    #####             ####
@@ -955,6 +957,11 @@ ${tripleTick}
 
 Remote Python Call (RPyC)
 `;
-    _testConvertToMarkdown(docstring, markdown);
+        _testConvertToMarkdown(docstring, markdown);
+    });
+}
+exports.docStringTests = docStringTests;
+describe('Doc String Conversion', () => {
+    docStringTests();
 });
 //# sourceMappingURL=docStringConversion.test.js.map