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

📚 Convention to differentiate between user and internal API #859

Closed
s-weigand opened this issue Oct 14, 2021 · 2 comments
Closed

📚 Convention to differentiate between user and internal API #859

s-weigand opened this issue Oct 14, 2021 · 2 comments
Assignees
Labels
Status: Lack of interest Issue went stale | cold | lack of (user) interest Type: Documentation Docs, Docs, Docs
Milestone

Comments

@s-weigand
Copy link
Member

Version information

All

Describe the issue

If we have a way to differentiate between user API and internal API users shouldn't touch (use on own risk), we could quickly determine if we need proper deprecation to preserve the current behavior or if it is ok to change it.

Expected documentation

Something like Internal API subject to changes, use on own risk!

or

We have some kind of allow list with all functions for the user API.

Additional context

For #851 we agreed that Problem isn't part of the official user API.

@s-weigand s-weigand added the Type: Documentation Docs, Docs, Docs label Oct 14, 2021
@s-weigand s-weigand added this to the v0.6.0 milestone Oct 15, 2021
@s-weigand s-weigand modified the milestones: v0.6.0, v0.7.0 Apr 2, 2022
@s-weigand s-weigand modified the milestones: v0.7.0, v1.0.0 Feb 4, 2023
@stale
Copy link

stale bot commented Jun 19, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: Lack of interest Issue went stale | cold | lack of (user) interest label Jun 19, 2023
Copy link

stale bot commented Dec 19, 2023

This issue has been closed due to lack of recent activity. Please open a new issue if you're still encountering this problem. Thanks for your contributions!

@stale stale bot closed this as completed Dec 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Lack of interest Issue went stale | cold | lack of (user) interest Type: Documentation Docs, Docs, Docs
Projects
None yet
Development

No branches or pull requests

3 participants