From 1515741f3ea79c9bfb279adde5e78262342d562f Mon Sep 17 00:00:00 2001 From: Marquis Kurt Date: Tue, 10 Aug 2021 16:08:50 -0400 Subject: [PATCH] :memo: Update documentation --- docs/97-deprecated.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/97-deprecated.md b/docs/97-deprecated.md index 5568255..637cc2b 100644 --- a/docs/97-deprecated.md +++ b/docs/97-deprecated.md @@ -2,12 +2,14 @@ Candella includes a small module that facilitates deprecating functions or restricting function to specific OS versions. -## `available` +## `@available` {label:new} Restrict usage of a function to specific OS versions. This can be used to determine if a method or function should be marked as deprecated, or if a function is only available on a specific minimum OS version. This decorator is inspired by the `@available` property wrapper in Swift. +Information about when the method or function was introduced and deprecated is added to the function's docstring. + ```py from store.CADeprecated import available