mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-09-03 20:52:55 -05:00
Closes #1840: [Napoleon] Fixes Google style parsing to only match section headers ending with exactly one colon
This commit is contained in:
@@ -561,6 +561,60 @@ Code sample for usage::
|
||||
actual = str(GoogleDocstring(docstring))
|
||||
self.assertEqual(expected, actual)
|
||||
|
||||
def test_section_header_formatting(self):
|
||||
docstrings = [("""
|
||||
Summary line
|
||||
|
||||
Example:
|
||||
Multiline reStructuredText
|
||||
literal code block
|
||||
|
||||
""", """
|
||||
Summary line
|
||||
|
||||
.. rubric:: Example
|
||||
|
||||
Multiline reStructuredText
|
||||
literal code block
|
||||
"""),
|
||||
################################
|
||||
("""
|
||||
Summary line
|
||||
|
||||
Example::
|
||||
|
||||
Multiline reStructuredText
|
||||
literal code block
|
||||
|
||||
""", """
|
||||
Summary line
|
||||
|
||||
Example::
|
||||
|
||||
Multiline reStructuredText
|
||||
literal code block
|
||||
"""),
|
||||
################################
|
||||
("""
|
||||
Summary line
|
||||
|
||||
:Example:
|
||||
|
||||
Multiline reStructuredText
|
||||
literal code block
|
||||
|
||||
""", """
|
||||
Summary line
|
||||
|
||||
:Example:
|
||||
|
||||
Multiline reStructuredText
|
||||
literal code block
|
||||
""")]
|
||||
for docstring, expected in docstrings:
|
||||
actual = str(GoogleDocstring(docstring))
|
||||
self.assertEqual(expected, actual)
|
||||
|
||||
|
||||
class NumpyDocstringTest(BaseDocstringTest):
|
||||
docstrings = [(
|
||||
@@ -1068,3 +1122,75 @@ Example Function
|
||||
app = mock.Mock()
|
||||
actual = str(NumpyDocstring(docstring, config, app, "method"))
|
||||
self.assertEqual(expected, actual)
|
||||
|
||||
def test_section_header_underline_length(self):
|
||||
docstrings = [("""
|
||||
Summary line
|
||||
|
||||
Example
|
||||
-
|
||||
Multiline example
|
||||
body
|
||||
|
||||
""", """
|
||||
Summary line
|
||||
|
||||
Example
|
||||
-
|
||||
Multiline example
|
||||
body
|
||||
"""),
|
||||
################################
|
||||
("""
|
||||
Summary line
|
||||
|
||||
Example
|
||||
--
|
||||
Multiline example
|
||||
body
|
||||
|
||||
""", """
|
||||
Summary line
|
||||
|
||||
.. rubric:: Example
|
||||
|
||||
Multiline example
|
||||
body
|
||||
"""),
|
||||
################################
|
||||
("""
|
||||
Summary line
|
||||
|
||||
Example
|
||||
-------
|
||||
Multiline example
|
||||
body
|
||||
|
||||
""", """
|
||||
Summary line
|
||||
|
||||
.. rubric:: Example
|
||||
|
||||
Multiline example
|
||||
body
|
||||
"""),
|
||||
################################
|
||||
("""
|
||||
Summary line
|
||||
|
||||
Example
|
||||
------------
|
||||
Multiline example
|
||||
body
|
||||
|
||||
""", """
|
||||
Summary line
|
||||
|
||||
.. rubric:: Example
|
||||
|
||||
Multiline example
|
||||
body
|
||||
""")]
|
||||
for docstring, expected in docstrings:
|
||||
actual = str(NumpyDocstring(docstring))
|
||||
self.assertEqual(expected, actual)
|
||||
|
||||
Reference in New Issue
Block a user