IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

[Napoleon] adds xref test data for pull request #3168

Browse Source
This commit is contained in:
Rob Ruana 2016-11-21 16:12:23 -08:00
parent 5c884a66bd
commit f4716ed3a3
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
tests/test_ext_napoleon.py
View File

@ -68,6 +68,7 @@ class SampleError(Exception):
def __special_undoc__(self): def __special_undoc__(self):
pass pass
SampleNamedTuple = namedtuple('SampleNamedTuple', 'user_id block_type def_id') SampleNamedTuple = namedtuple('SampleNamedTuple', 'user_id block_type def_id')

12
tests/test_ext_napoleon_docstring.py
View File

@ -284,8 +284,9 @@ Construct a new XBlock.
This class should only be used by runtimes. This class should only be used by runtimes.
Arguments: Arguments:
runtime (:class:`Runtime`): Use it to access the environment. runtime (:class:`~typing.Dict`\[:class:`int`,:class:`str`\]): Use it to
It is available in XBlock code as ``self.runtime``. access the environment. It is available in XBlock code
as ``self.runtime``.
field_data (:class:`FieldData`): Interface used by the XBlock field_data (:class:`FieldData`): Interface used by the XBlock
fields to access their data from wherever it is persisted. fields to access their data from wherever it is persisted.
@ -300,9 +301,10 @@ Construct a new XBlock.
This class should only be used by runtimes. This class should only be used by runtimes.
:param runtime: Use it to access the environment. :param runtime: Use it to
It is available in XBlock code as ``self.runtime``. access the environment. It is available in XBlock code
:type runtime: :class:`Runtime` as ``self.runtime``.
:type runtime: :class:`~typing.Dict`\[:class:`int`,:class:`str`\]
:param field_data: Interface used by the XBlock :param field_data: Interface used by the XBlock
fields to access their data from wherever it is persisted. fields to access their data from wherever it is persisted.
:type field_data: :class:`FieldData` :type field_data: :class:`FieldData`