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

fix style check warnings

Browse Source
This commit is contained in:
Yoshiki Shibukawa 2017-03-03 22:00:35 +09:00
parent 8f5d1e1050
commit 7e178785a7
4 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/ext/example_google.py
View File

@ -83,7 +83,7 @@ def module_level_function(param1, param2=None, *args, **kwargs):
of each parameter is required. The type and description of each parameter of each parameter is required. The type and description of each parameter
is optional, but should be included if not obvious. is optional, but should be included if not obvious.
If \*args or \*\*kwargs are accepted, If ``*args`` or ``**kwargs`` are accepted,
they should be listed as ``*args`` and ``**kwargs``. they should be listed as ``*args`` and ``**kwargs``.
The format for a parameter is:: The format for a parameter is::

2
doc/ext/example_numpy.py
View File

@ -106,7 +106,7 @@ def module_level_function(param1, param2=None, *args, **kwargs):
The name of each parameter is required. The type and description of each The name of each parameter is required. The type and description of each
parameter is optional, but should be included if not obvious. parameter is optional, but should be included if not obvious.
If \*args or \*\*kwargs are accepted, If ``*args`` or ``**kwargs`` are accepted,
they should be listed as ``*args`` and ``**kwargs``. they should be listed as ``*args`` and ``**kwargs``.
The format for a parameter is:: The format for a parameter is::

2
tests/test_build_latex.py
View File

@ -491,7 +491,7 @@ def test_footnote(app, status, warning):
'VIDIOC\\_CROPCAP\n&\n') in result 'VIDIOC\\_CROPCAP\n&\n') in result
assert ('Information about VIDIOC\\_CROPCAP %\n' assert ('Information about VIDIOC\\_CROPCAP %\n'
'\\begin{footnote}[6]\\sphinxAtStartFootnote\n' '\\begin{footnote}[6]\\sphinxAtStartFootnote\n'
'footnote in table not in header\n%\n\\end{footnote}\n\\\\\n\hline\n' 'footnote in table not in header\n%\n\\end{footnote}\n\\\\\n\\hline\n'
'\\end{tabulary}\n\\end{threeparttable}\n\\par\n\\end{savenotes}\n') in result '\\end{tabulary}\n\\end{threeparttable}\n\\par\n\\end{savenotes}\n') in result

4
tests/test_ext_napoleon_docstring.py
View File

@ -284,7 +284,7 @@ Construct a new XBlock.
This class should only be used by runtimes. This class should only be used by runtimes.
Arguments: Arguments:
runtime (:class:`~typing.Dict`\[:class:`int`,:class:`str`\]): Use it to runtime (:class:`~typing.Dict`\\[:class:`int`,:class:`str`\\]): Use it to
access the environment. It is available in XBlock code access the environment. It is available in XBlock code
as ``self.runtime``. as ``self.runtime``.
@ -304,7 +304,7 @@ This class should only be used by runtimes.
:param runtime: Use it to :param runtime: Use it to
access the environment. It is available in XBlock code access the environment. It is available in XBlock code
as ``self.runtime``. as ``self.runtime``.
:type runtime: :class:`~typing.Dict`\[:class:`int`,:class:`str`\] :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`