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

Add option to add more verbose function documentation #6

Open
JoelKronander opened this issue Dec 20, 2022 · 0 comments
Open

Add option to add more verbose function documentation #6

JoelKronander opened this issue Dec 20, 2022 · 0 comments

Comments

@JoelKronander
Copy link

One cool feature could be to allow docgpt to output more verbose function docs.
Like with arguments and in a typical document parser style. e.g. Sphinx.

eg.

def my_function(my_arg: str, my_second_arg: float) -> float:
return len(my_arg)/my_second_arg

could add the function docstring

""" Counts the number of characters in the string, and divides by my_second_arg. """

Args:
my_arg: The string to count characters of
my_second_arg: the float to divide by.

Returns:
the result...
"""

Obviosuly the above example would make more sense for longer functions.

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

No branches or pull requests

1 participant