summaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorRob Ruana <rob@relentlessidiot.com>2014-04-19 03:58:11 -0400
committerRob Ruana <rob@relentlessidiot.com>2014-04-19 03:58:11 -0400
commit708a9ecbb0e0e7caf94a617a77efc3e7b01d64de (patch)
treebedcdd921908edabe9d2c639ff80f720ab7b8158 /tests
parentf69b8eae1e93c3f6c92d589ba583c2ea33233907 (diff)
downloadsphinx-708a9ecbb0e0e7caf94a617a77efc3e7b01d64de.tar.gz
Closes 1455: Adds better handling of namedtuples in napoleon's skipmember function
Diffstat (limited to 'tests')
-rw-r--r--tests/test_napoleon.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/tests/test_napoleon.py b/tests/test_napoleon.py
index e16c02b6..78d455a0 100644
--- a/tests/test_napoleon.py
+++ b/tests/test_napoleon.py
@@ -15,6 +15,7 @@ try:
from unittest.mock import Mock
except ImportError:
from mock import Mock
+from collections import namedtuple
from sphinx.application import Sphinx
from sphinx.ext.napoleon import (_process_docstring, _skip_member, Config,
setup)
@@ -70,6 +71,8 @@ class SampleError(Exception):
def __special_undoc__(self):
pass
+SampleNamedTuple = namedtuple('SampleNamedTuple', 'user_id block_type def_id')
+
class ProcessDocstringTest(TestCase):
def test_modify_in_place(self):
@@ -137,6 +140,11 @@ class SkipMemberTest(TestCase):
self.assertEqual(skip, _skip_member(app, what, member, obj, skip,
Mock()))
+ def test_namedtuple(self):
+ self.assertSkip('class', '_asdict',
+ SampleNamedTuple._asdict, False,
+ 'napoleon_include_private_with_doc')
+
def test_class_private_doc(self):
self.assertSkip('class', '_private_doc',
SampleClass._private_doc, False,