class BaseDocstringTest(TestCase):
Known subclasses: pydoctor.test.test_napoleon_docstring.GoogleDocstringTest, pydoctor.test.test_napoleon_docstring.InlineAttributeTest, pydoctor.test.test_napoleon_docstring.NumpyDocstringTest, pydoctor.test.test_napoleon_docstring.TypeDocstringTest
Undocumented
| Method | assertAlmostEqualSphinxDocstring |
Check if the upstream version of the parser class (from sphinx.ext.napoleon) parses the docstring as expected. |
| Class Variable | maxDiff |
Undocumented |
Check if the upstream version of the parser class (from sphinx.ext.napoleon)
parses the docstring as expected.
This is used as a supplementary manner of testing the parser behaviour.
Some approximation are applied with re.sub to the expected string and the reST
docstring generated by sphinx.ext.napoleon classes. This is done in order to use
the expected reST strings designed for pydoctor.napoleon and apply them to sphinx.ext.napoleon in the same test.
Tho, not all tests cases can be adapted to pass this check.
| Parameters | |
expected:str | The exact expected reST docstring generated by pydoctor.napoleon classes (trailling whitespaces ignored) |
docstring:str | Undocumented |
type_:Type[ | Undocumented |