[feature] update docstring

[Freed-Wu]

test.py

def f(x: int) -> int:
    """f.

    :param x:
    :type x: int
    :rtype: int
    """
    return x

change test.py to

def f(x: float) -> float:
    """f.

    :param x:
    :type x: int
    :rtype: int
    """
    return x

Now use codeaction pydocstring

def f(x: float) -> float:
    """f.

    :param x:
    :type x: float
    :rtype: float
    """
    """f.

    :param x:
    :type x: int
    :rtype: int
    """
    return x

Expected behaviour:

def f(x: float) -> float:
    """f.

    :param x:
    :type x: float
    :rtype: float
    """
    return x

Thanks!

[yaegassy]

Thanks for the feature request.

Unfortunately, the doq command used in coc-pydocstring does not return results that can be overridden.

(venv) pydocstring-check$ bat test.py
───────┬───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
       │ File: test.py
───────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
   1   │ def f(x: float) -> float:
   2   │     """f.
   3   │
   4   │     :param x:
   5   │     :type x: int
   6   │     :rtype: int
   7   │     """
   8   │     return x
───────┴───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
(venv) pydocstring-check$ cat test.py | doq --start 1 --end 2
def f(x: float) -> float:
    """f.

    :param x:
    :type x: float
    :rtype: float
    """
    """f.

Also, adding your own overwriting process might be a source of bugs. :(

[Freed-Wu]

I see, the feature should be implemented in the upstream (py-doq).

Thanks!

[yaegassy]

@Freed-Wu To be honest, I don't like that feature addition. :(

I'm not keen on adding this feature because I think it's just a matter of manually deleting the content.

Also, if you are submitting a feature request issue to py-doq, you should include more details than just a link to this issue.

[yaegassy]

@Freed-Wu Please check this issue.

• Docstring updating heavenshell/py-doq#30
• Reuse existing docstring heavenshell/vim-pydocstring#107