Skip to content

Commit

Permalink
📝 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alicerunsonfedora committed Aug 10, 2021
1 parent 9c91a77 commit 1515741
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/97-deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 1515741

Please sign in to comment.