Skip to content

Commit

Permalink
📝 Remove deprecated functions from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alicerunsonfedora committed Mar 8, 2021
1 parent a0ac924 commit b5710ce
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 18 deletions.
9 changes: 0 additions & 9 deletions docs/03-candella-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 0 additions & 9 deletions docs/05-multiuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit b5710ce

Please sign in to comment.