summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRemy Oukaour <remy.oukaour@gmail.com>2017-12-28 11:50:02 -0500
committerRemy Oukaour <remy.oukaour@gmail.com>2017-12-28 11:50:02 -0500
commit0ceee9696a2a9045697d01c89761b6cee9dea861 (patch)
tree27cbb13d66bb040ab53ac5521954f52942e7905f
parentfe92e4d848eacba957fac472322ae16698451987 (diff)
Explain what bugs, glitches, and flaws are
-rw-r--r--docs/bugs_and_glitches.md2
-rw-r--r--docs/design_flaws.md2
2 files changed, 4 insertions, 0 deletions
diff --git a/docs/bugs_and_glitches.md b/docs/bugs_and_glitches.md
index 69f902eb0..2382a8e29 100644
--- a/docs/bugs_and_glitches.md
+++ b/docs/bugs_and_glitches.md
@@ -1,5 +1,7 @@
# Bugs and Glitches
+These are known bugs and glitches in the original Pokémon Crystal game: code that clearly does not work as intended, or that only works in limited circumstances but has the possibility to fail or crash.
+
## Contents
diff --git a/docs/design_flaws.md b/docs/design_flaws.md
index 1ddc92094..bcd7ea516 100644
--- a/docs/design_flaws.md
+++ b/docs/design_flaws.md
@@ -1,5 +1,7 @@
# Design Flaws
+These are parts of the code that do not work *incorrectly*, like [bugs and glitches](/docs/bugs_and_glitches.md), but that clearly exist just to work around a problem. In other words, with a slightly different design, the code would not need to exist at all. Design flaws may be exceptions to a usual rule, such as "tables of pointers in different banks use `dba`" ([one exception](#pic-banks-are-offset-by-pics_fix), [and another](#pokédex-entry-banks-are-derived-from-their-species-ids)) or "graphics used as a unit as stored and loaded contiguously" ([a notable exception](#footprints-are-split-into-top-and-bottom-halves)).
+
## Contents