pydocstring icon indicating copy to clipboard operation
pydocstring copied to clipboard

Updating Docstrings with parameters/exceptions/etc that change

Open robodair opened this issue 7 years ago • 2 comments

robodair avatar Sep 19 '17 10:09 robodair

Hi @robodair !

In my own implementation of something similar to your project I have already developed this feature.

Here you can see how the existing docstring gets updated when new parameters are added to the function signature: https://github.com/wizmer/py-code-assist/blob/master/tests/test_docstring.py#L19

If you are interested, I could make a PR to add this functionality to your project.

Also, I am also a bit involved in the maintenance of https://github.com/peterewills/sphinx-doc.el which is an emacs project for python docstring generation. I have just created a ticket to consider switching to your backend: https://github.com/naiquevin/sphinx-doc.el/issues/33

wizmer avatar Dec 15 '21 10:12 wizmer

Hey @wizmer! I would love a PR if you feel like making one.

Though it's been a long time since I've done any active work on this project (I was at uni) I have a little more time now and I've been meaning to bring everything up to date and flesh out these features.

robodair avatar Dec 15 '21 11:12 robodair