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.

Sign up for GitHub

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

Update Obsolete attribute guideline #6452

Merged
merged 1 commit into from
Feb 27, 2023
+1 −1
Merged

Update Obsolete attribute guideline #6452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/community/contributing/api-changes-compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,6 @@ How do these resolve some of the frustrating problems around versioning?

What does this look like in practice?

1. Old, no-longer-recommended methods still function but are marked with an `Obsolete` attribute;
1. Old, no-longer-recommended methods still function but are marked with an `Obsolete` attribute. This `Obsolete` attribute argument has to contain the string "Obsolete since v{current-akka-version}";
2. New methods are made opt-in if their behavior differs significantly from previous implementations; and
3. We add new overloads when we need to pass in new values or parameters, rather than change existing method signatures.