Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C++, add retval info field #9694

Merged
merged 2 commits into from
Oct 1, 2021
Merged

C++, add retval info field #9694

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91d0289
C++, add retval info field to cpp:function
jakobandersen Oct 1, 2021
a6246c1
Typo fixes
jakobandersen Oct 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Typo fixes
  • Loading branch information
@jakobandersen
jakobandersen committed Oct 1, 2021
commit a6246c1b655205bb4a917e38f4566a97385ab862
2 changes: 1 addition & 1 deletion CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Features added
* #9639: autodoc: Support asynchronous generator functions
* #9664: autodoc: ``autodoc-process-bases`` supports to inject reST snippet as a
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`.
* C++, added new info-field ``retval`` for :rst:dir:`cpp:function`.

Expand Down
4 changes: 2 additions & 2 deletions doc/usage/restructuredtext/domains.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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`).

* ``param``, ``parameter``, ``arg``, ``argument``,
Expand Down Expand Up @@ -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
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.

.. versionadded:: 3.0
Expand Down