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

General Issue: Deprecation Section removed from core admiral #342

Open
3 tasks
bms63 opened this issue Oct 25, 2023 · 2 comments
Open
3 tasks

General Issue: Deprecation Section removed from core admiral #342

bms63 opened this issue Oct 25, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@bms63
Copy link
Collaborator

bms63 commented Oct 25, 2023

Background Information

As we are strongly discouraging the deprecation of any functions - just function arguments - the section on deprecation is no longer needed. The changelog can be a stand-in for tracking any further documentation around deprecation.

Note that a superseded section has been created and should be documented as well.

Definition of Done

  • Note in the Deprecation section that the Reference section has been removed
  • Note a strong wording on discouraging the deprecation of functions in admiral
  • Note what is superseded and how we approach it in admiral
@bms63 bms63 added the documentation Improvements or additions to documentation label Oct 25, 2023
@bundfussr
Copy link
Collaborator

Note a strong wording on no longer deprecating functions in admiral

I think "no longer deprecating functions" sounds rather like a stale package than a stable package. We still should have the option to deprecate functions but should not use it as extensive as in the past.

@bms63
Copy link
Collaborator Author

bms63 commented Oct 31, 2023

Note a strong wording on no longer deprecating functions in admiral

I think "no longer deprecating functions" sounds rather like a stale package than a stable package. We still should have the option to deprecate functions but should not use it as extensive as in the past.

updated

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
Development

No branches or pull requests

2 participants