mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
fix style check warnings
This commit is contained in:
parent
8f5d1e1050
commit
7e178785a7
@ -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
|
||||
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``.
|
||||
|
||||
The format for a parameter is::
|
||||
|
@ -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
|
||||
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``.
|
||||
|
||||
The format for a parameter is::
|
||||
|
@ -491,7 +491,7 @@ def test_footnote(app, status, warning):
|
||||
'VIDIOC\\_CROPCAP\n&\n') in result
|
||||
assert ('Information about VIDIOC\\_CROPCAP %\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
|
||||
|
||||
|
||||
|
@ -284,7 +284,7 @@ Construct a new XBlock.
|
||||
This class should only be used by runtimes.
|
||||
|
||||
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
|
||||
as ``self.runtime``.
|
||||
|
||||
@ -304,7 +304,7 @@ This class should only be used by runtimes.
|
||||
:param runtime: Use it to
|
||||
access the environment. It is available in XBlock code
|
||||
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
|
||||
fields to access their data from wherever it is persisted.
|
||||
:type field_data: :class:`FieldData`
|
||||
|
Loading…
Reference in New Issue
Block a user