Skip to content

Commit

Permalink
Update Obsolete attribute guideline (#6452)
Browse files Browse the repository at this point in the history
  • Loading branch information
Arkatufus committed Feb 27, 2023
1 parent 99bbd80 commit 76b1e80
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/community/contributing/api-changes-compatibility.md
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.

0 comments on commit 76b1e80

Please sign in to comment.