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

Allowing None to parse #88

Open
jamesbraza opened this issue Jun 26, 2024 · 0 comments
Open

Allowing None to parse #88

jamesbraza opened this issue Jun 26, 2024 · 0 comments

Comments

@jamesbraza
Copy link

As of docstring_parser==0.16, parse is actually safe to being input None as the text.

Can we type hint it to allow this? That way, parse can be invoked on functions that don't have a __doc__ attribute:

from docstring_parser import parse

def foo():
    pass

parse(foo.__doc__)  # This is runtime safe, just needs to be type safe
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