Skip to content

[ReST] Make return/returns keyword parametrizableΒ #14

@G-nn-r

Description

@G-nn-r

ReST allows both :return: and :returns: as keywords for the return values of functions and methods (see here).

Currently, docconvert uses :returns: , although many projects use :return:. It would be great to have this parametrizable, e.g., in the config.

Workaround:

In docconvert/writer/rest.py (e.g., D:\envs\my-venv\Lib\site-packages\docconvert\writer\rest.py), change line 113 from:
header = self._field_token.format("returns")
to
header = self._field_token.format("return")
(Just omit the s.)

Thanks in advance πŸ™‚

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions