mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Typo fixes
This commit is contained in:
parent
91d0289009
commit
a6246c1b65
2
CHANGES
2
CHANGES
@ -19,7 +19,7 @@ Features added
|
|||||||
* #9639: autodoc: Support asynchronous generator functions
|
* #9639: autodoc: Support asynchronous generator functions
|
||||||
* #9664: autodoc: ``autodoc-process-bases`` supports to inject reST snippet as a
|
* #9664: autodoc: ``autodoc-process-bases`` supports to inject reST snippet as a
|
||||||
base class
|
base class
|
||||||
* 9691: C, added new info-field ``retval``
|
* #9691: C, added new info-field ``retval``
|
||||||
for :rst:dir:`c:function` and :rst:dir:`c:macro`.
|
for :rst:dir:`c:function` and :rst:dir:`c:macro`.
|
||||||
* C++, added new info-field ``retval`` for :rst:dir:`cpp:function`.
|
* C++, added new info-field ``retval`` for :rst:dir:`cpp:function`.
|
||||||
|
|
||||||
|
@ -677,7 +677,7 @@ The C domain (name **c**) is suited for documentation of C API.
|
|||||||
Note that you don't have to backslash-escape asterisks in the signature, as
|
Note that you don't have to backslash-escape asterisks in the signature, as
|
||||||
it is not parsed by the reST inliner.
|
it is not parsed by the reST inliner.
|
||||||
|
|
||||||
In the description of a function you can use the following info-fields
|
In the description of a function you can use the following info fields
|
||||||
(see also :ref:`info-field-lists`).
|
(see also :ref:`info-field-lists`).
|
||||||
|
|
||||||
* ``param``, ``parameter``, ``arg``, ``argument``,
|
* ``param``, ``parameter``, ``arg``, ``argument``,
|
||||||
@ -723,7 +723,7 @@ The C domain (name **c**) is suited for documentation of C API.
|
|||||||
Describes a C macro, i.e., a C-language ``#define``, without the replacement
|
Describes a C macro, i.e., a C-language ``#define``, without the replacement
|
||||||
text.
|
text.
|
||||||
|
|
||||||
In the description of a macro you can use the same info-fields as for the
|
In the description of a macro you can use the same info fields as for the
|
||||||
:rst:dir:`c:function` directive.
|
:rst:dir:`c:function` directive.
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
|
Loading…
Reference in New Issue
Block a user