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

Marking experimental API elements #654

Open
lars-reimann opened this issue Apr 24, 2024 · 0 comments
Open

Marking experimental API elements #654

lars-reimann opened this issue Apr 24, 2024 · 0 comments
Assignees
Labels
documentation 📖 Improvements or additions to documentation

Comments

@lars-reimann
Copy link
Member

Once we start stabilizing the API, we should have a way to mark the remaining experimental API elements. Since Python does not have a built-in mechanism for this, I'd propose that we add the prefix experimental_ to their name. This is obvious and guarantees that there is going to be a breaking change involving this API element in the future. We should document this somewhere.

@lars-reimann lars-reimann added the documentation 📖 Improvements or additions to documentation label Apr 24, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Library Apr 24, 2024
@lars-reimann lars-reimann self-assigned this May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

1 participant