diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-01-17 09:11:59 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-01-17 09:11:59 +0900 |
| commit | 7906a6871ecf1e4b0cdfc73fb3ac35bd2bb3719d (patch) | |
| tree | 277df1e27f062df8f45475118833ca38681b1893 /tests/test_autodoc.py | |
| parent | ef811532c9102176a82605d1c62c1cfe68a9e870 (diff) | |
| download | sphinx-git-7906a6871ecf1e4b0cdfc73fb3ac35bd2bb3719d.tar.gz | |
Add testcase a partialmethod not having docstring (refs: #7023)
Diffstat (limited to 'tests/test_autodoc.py')
| -rw-r--r-- | tests/test_autodoc.py | 35 |
1 files changed, 32 insertions, 3 deletions
diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index bd13cf6c2..6de2233d1 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -1324,11 +1324,39 @@ def test_partialmethod(app): ' Make a cell alive.', ' ', ' ', - ' .. py:method:: Cell.set_dead()', + ' .. py:method:: Cell.set_state(state)', ' :module: target.partialmethod', ' ', - ' Make a cell dead.', + ' Update state of cell to *state*.', ' ', + ] + + options = {"members": None} + actual = do_autodoc(app, 'class', 'target.partialmethod.Cell', options) + assert list(actual) == expected + + +@pytest.mark.sphinx('html', testroot='ext-autodoc') +def test_partialmethod_undoc_members(app): + expected = [ + '', + '.. py:class:: Cell', + ' :module: target.partialmethod', + '', + ' An example for partialmethod.', + ' ', + ' refs: https://docs.python.jp/3/library/functools.html#functools.partialmethod', + ' ', + ' ', + ' .. py:method:: Cell.set_alive()', + ' :module: target.partialmethod', + ' ', + ' Make a cell alive.', + ' ', + ' ', + ' .. py:method:: Cell.set_dead()', + ' :module: target.partialmethod', + ' ', ' ', ' .. py:method:: Cell.set_state(state)', ' :module: target.partialmethod', @@ -1337,7 +1365,8 @@ def test_partialmethod(app): ' ', ] - options = {"members": None} + options = {"members": None, + "undoc-members": None} actual = do_autodoc(app, 'class', 'target.partialmethod.Cell', options) assert list(actual) == expected |