Skip to content

Commit

Permalink
Update graph/patterns/evolvable-enums.md
Browse files Browse the repository at this point in the history
Co-authored-by: Darrel <[email protected]>
  • Loading branch information
PetRich-MSFT and darrelmiller authored Apr 6, 2022
1 parent 86b3dbd commit 10d1589
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion graph/patterns/evolvable-enums.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The solution here is to add a 'sentinel' member named ```unknownFutureValue``` a

---

- It is a best practice to include a ```unknownFutureValue``` value when the enum is initially introduced to allow flexibility to extend the enum during the lifetime of the API. Even if the API producer believes they have included all possible members in an enum it is still strongly recommended to include a ```unknownFutureValue``` member to allow for unforeseen future circumstances which may required extending the enum.
- It is a best practice to include a ```unknownFutureValue``` value when the enum is initially introduced to allow flexibility to extend the enum during the lifetime of the API. Even if the API producer believes they have included all possible members in an enum it is still strongly recommended to include a ```unknownFutureValue``` member to allow for unforeseen future circumstances which may require extending the enum.

- This pattern must not be used in scenarios where an API consumer wants to use enum members that are not known to the API producer.

Expand Down

0 comments on commit 10d1589

Please sign in to comment.