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

Allow generating explicit sections #165

Open
ColinKennedy opened this issue Feb 7, 2024 · 3 comments · May be fixed by #201
Open

Allow generating explicit sections #165

ColinKennedy opened this issue Feb 7, 2024 · 3 comments · May be fixed by #201
Labels
enhancement New feature or request

Comments

@ColinKennedy
Copy link
Contributor

ColinKennedy commented Feb 7, 2024

Sometimes I just need to generate only the Returns: portion of a Google-style Python docstring. It'd be cool to have an API to do generate just X or Y section of a full docstring if it doesn't already exist. I played around a bit with the source and it seems doable without that too much work since all of the docstring templates are already annotated with types. If this doesn't already exist, would you be up for a PR to add it?

@Willem-J-an
Copy link

+1, addition: to remove parameters that were removed!

@danymat
Copy link
Owner

danymat commented Mar 3, 2024

Hey @ColinKennedy , indeed the code still does not exist. You can start writing something for that, else I will do a suggestion
@Willem-J-an, I do not understand your addition, can you elaborate a bit ? Is this the idea to update the annotation based on what's been added/deleted ? Is this related to #65 ?

@danymat danymat added the enhancement New feature or request label Mar 3, 2024
@Willem-J-an
Copy link

Yes! That's what I was thinking about!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants