docconvert

docconvert copied to clipboard

Handle multiple C{type} in an epytext docstring

7

Reading the following docstring ``` """ Blah :Parameters: arg1 :C{string} or C{int} Does something """ ``` results in the following Google docstring ``` """Blah Args: arg1 (string} or C{int): Does...

AWhetter

At the moment we always add a return type even when use_types is off. If using type annotations, google, rest, and epytext output all support just defining a return docstring...

cbillingham

Docconvert fails to parse a somewhat edge case pattern involving `...` in a context manager. Here is a minimal example: ``` import pytest def test_x(): with pytest.warns(UserWarning, match="this is a...

aquirdTurtle

Hi Cameron, thanks for your nice reformatting tool :) Using it in my repository lead to the following behaviour: Before running docconvert: ```py def abc(): """Text. Text text text text....

janadaub

[The documentation of the docconvert](https://docconvert.readthedocs.io/en/latest/intro.html#usage) only describes the usage within the CLI. When using this module from within a Python file, we can use the `sys` module to use it...

ma-habibi

ReST allows both `:return:` and `:returns:` as keywords for the return values of functions and methods (see [here](https://www.sphinx-doc.org/en/master/usage/domains/python.html#info-field-lists)). Currently, docconvert uses `:returns:` , although many projects use `:return:`. It would...

G-nn-r