diff options
| author | Rangi <35663410+Rangi42@users.noreply.github.com> | 2018-07-17 16:47:51 -0400 |
|---|---|---|
| committer | Rangi <35663410+Rangi42@users.noreply.github.com> | 2018-07-17 16:47:51 -0400 |
| commit | 3584b8168728a9633a144bee2f066b57fb239c7e (patch) | |
| tree | 0130b52f5e860c00b67b2a3db17982fa77845fdc | |
| parent | ccf446c875815da7d9e4a40ea3bd43d87c2e52d6 (diff) | |
Updated Code cleanup (markdown)
| -rw-r--r-- | Code-cleanup.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Code-cleanup.md b/Code-cleanup.md index b2a4a60..e88872e 100644 --- a/Code-cleanup.md +++ b/Code-cleanup.md @@ -1,6 +1,6 @@ These are all general issues with the pokecrystal code. Keep an eye out for opportunities to refactor them. -- Meaningless temporary labels: `UnknownText_*`, `UnknownScript_*`, `Unknown_*`, and `Function_*` +- **Meaningless temporary labels:** `UnknownText_*`, `UnknownScript_*`, `Unknown_*`, and `Function_*` - **Hard-coded "magic numbers":** Most of the time, raw numbers should not exist because there are more meaningful replacements. Examples: - `BANK(Label)` (mostly finished for WRAM labels, but still a problem with mobile code) @@ -9,4 +9,4 @@ These are all general issues with the pokecrystal code. Keep an eye out for oppo - `SOME_BIT_F` bit flags, and `1 << SOME_BIT_F` masks (various hex and binary literals indicate an opportunity for this) - Jumptable indexes (look for raw values being loaded into `[wJumptableIndex]`) -- Text label styles in [data/text/](../tree/master/data/text/) should be consistent, not a mixture of `Text_*`, `*Text`, and `BattleText_*`. Likewise for the [engine/](../tree/master/engine/) labels that just `text_jump` to one of them. +- **Text label styles** in [data/text/](../tree/master/data/text/) should be consistent, not a mixture of `Text_*`, `*Text`, and `BattleText_*`. Likewise for the [engine/](../tree/master/engine/) labels that just `text_jump` to one of them. |