forked from UnscriptedVN/candella
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 [docs + S/C/Roland] Update docs, Roland
- Loading branch information
1 parent
f23a526
commit 4436bc7
Showing
10 changed files
with
61 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Design and branding | ||
|
||
Candella includes utilities and modules that help ensure the system's design language is followed, as well as provide branding images. | ||
|
||
## Design | ||
|
||
Candella, in large part, follows the Suru design guidelines and is commonly seen in the icons and font (Ubuntu). The `CADesign` module contains some utilities to help facilitate following the design language. | ||
|
||
### `get_app_mask_frame()` | ||
|
||
Returns a Frame object with a mask of the app's general shape. | ||
|
||
### `get_app_mask(icon, size)` | ||
|
||
Returns an AlphaMask displayable with the app's general shape masked on to the specified `icon` with a size of `size x size` pixels. | ||
|
||
## Branding | ||
|
||
The `Branding` directory inside of the `System/Library` directory contains logomarks and sprites that can be used throughout Candella. Please, do not use these images to represent your app or service. | ||
|
||
 | ||
<small> | ||
|
||
*The logomark is best used on a dark background. | ||
|
||
</small> | ||
|
||
| | | | ||
| - | - | | ||
|  |  | | ||
|
||
Note that, for fonts, the Ubuntu font is used. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Deprecations | ||
|
||
Candella includes a small module that facilitates deprecating functions. To mark a function as deprecated, import the function and decorate the function you want to deprecate: | ||
|
||
```py | ||
from store.CADeprecated import deprecated | ||
|
||
@deprecated('21.02') | ||
def deprecated_func(): | ||
pass | ||
|
||
``` | ||
|
||
When the function is called, a warning message will appear in the console and the Candella log file indicating that the function was deprecated, as well as the reason for the deprecation, if one was specified. | ||
|
||
!!! important | ||
The `deprecated` function has been tested on functions and class methods, but hasn't been tested or designed for variables, class fields, or classes themselves. Use with caution. | ||
|
||
## `deprecated` arguments | ||
|
||
- `version` (str): The version in which the function will be deprecated. | ||
- `renamed` (str): (Optional) What the function has been renamed to, if the function was renamed. | ||
- `reason` (str): (Optional) The reason why the function was deprecated. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters