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.

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

Updating Docstrings with parameters/exceptions/etc that change #5

Open
robodair opened this issue Sep 19, 2017 · 2 comments
Open

Updating Docstrings with parameters/exceptions/etc that change #5

robodair opened this issue Sep 19, 2017 · 2 comments

Comments

@robodair
Copy link
Owner

No description provided.

@wizmer
Copy link
Contributor

wizmer commented Dec 15, 2021

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: naiquevin/sphinx-doc.el#33

@robodair
Copy link
Owner Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants