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

Use Griffe's public API #897

Closed
pawamoy opened this issue Dec 26, 2024 · 2 comments · Fixed by #898
Closed

Use Griffe's public API #897

pawamoy opened this issue Dec 26, 2024 · 2 comments · Fixed by #898

Comments

@pawamoy
Copy link

pawamoy commented Dec 26, 2024

You're importing from the internal API:

from _griffe.enumerations import DocstringSectionKind
from _griffe.models import Docstring

...exposing yourself to breakages.

Public equivalent:

from griffe import DocstringSectionKind, Docstring 
@ahuang11
Copy link
Contributor

Thank you for spotting that. Fixed in #898

@pawamoy
Copy link
Author

pawamoy commented Dec 26, 2024

Nice, thanks for the quick fix!

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

Successfully merging a pull request may close this issue.

2 participants