From b5710ce17f831ac977852315639c061919396142 Mon Sep 17 00:00:00 2001 From: Marquis Kurt Date: Mon, 8 Mar 2021 09:54:42 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Remove=20deprecated=20functions?= =?UTF-8?q?=20from=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/03-candella-app.md | 9 --------- docs/05-multiuser.md | 9 --------- 2 files changed, 18 deletions(-) diff --git a/docs/03-candella-app.md b/docs/03-candella-app.md index 3d0d4af..7b05237 100644 --- a/docs/03-candella-app.md +++ b/docs/03-candella-app.md @@ -128,21 +128,12 @@ Apps can also store data for the currently logged-in user on the system; this da There are three methods in `AppStorage` to help read and write data accordingly: -{label:new} - - `AppStorage.get_entry(field, raise_falsy=False)` will fetch the value for a field or return `None` if no value for the field was found. If `raise_falsy` is set to `True`, the method will instead raise an exception. - `AppStorage.set_entry(field, value)` will write the value `value` into the specified `field`. - `AppStorage.commit()` will commit all written changes to the current user's data file. !!! danger "Sensitive Information" Do _**not**_ store sensitive information in app storage unless you are using cryptography to encrypt the information. App storage is provided in the user's data file in a human-readable format and may be easily compromised if not encrypted properly. -### {label:deprecated} - -- `AppStorage.read(field)` will fetch the value for a field or return `None` if no value for the field was found. -- `AppStorage.read_not_none(field)` will fetch the value for a field or throw an exception if there is no value. -- `AppStorage.write_field(field, value)` will write the value `value` into the specified `field`. -- `AppStorage.write()` will commit all written changes to the current user's data file. - ## User interfaces diff --git a/docs/05-multiuser.md b/docs/05-multiuser.md index d675658..601560e 100644 --- a/docs/05-multiuser.md +++ b/docs/05-multiuser.md @@ -37,21 +37,12 @@ Likewise, core services in Candella utilize the `ServiceStorage` class. Like `Ap There are three methods available for managing service data: -{label:new} - - `ServiceStorage.get_entry(field, raise_falsy=False)` will fetch the value for a field or return `None` if no value for the field was found. If `raise_falsy` is set to `True`, the method will instead raise an exception. - `ServiceStorage.set_entry(field, value)` will write the value `value` into the specified `field`. - `ServiceStorage.commit()` will commit all written changes to the current user's data file. !!! danger "Sensitive Information" Do _**not**_ store sensitive information in service storage unless you are using cryptography to encrypt the information. Service storage is provided in the user's data file in a human-readable format and may be easily compromised if not encrypted properly. -#### {label:deprecated} - -- `ServiceStorage.read(field)` will fetch the value for a field or return `None` if no value for the field was found. -- `ServiceStorage.read_not_none(field)` will fetch the value for a field or throw an exception if there is no value. -- `ServiceStorage.write_field(field, value)` will write the value `value` into the specified `field`. -- `ServiceStorage.write()` will commit all written changes to the current user's data file. - ### Global scope access