aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <mssola@mssola.com>2026-04-14 11:17:09 +0200
committerMiquel Sabaté Solà <mssola@mssola.com>2026-04-14 11:17:09 +0200
commit903f305f2ec24220deb85865383914f57a6c650a (patch)
tree3723c4b3b5ec2e79c2b886a19466e55effc223b8
parent2e56bf9807898c6866856008f70ebea474f03987 (diff)
downloadstyle.nes-903f305f2ec24220deb85865383914f57a6c650a.tar.gz
style.nes-903f305f2ec24220deb85865383914f57a6c650a.zip
Simplify wording on arguments and returned values
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
-rw-r--r--README.md10
1 files changed, 2 insertions, 8 deletions
diff --git a/README.md b/README.md
index bcc8ec0..b9a3e0b 100644
--- a/README.md
+++ b/README.md
@@ -399,14 +399,8 @@ stack overflows are a real danger here.
It is generally a good idea to reserve some bytes for argument passing. For
example, one might reserve `$00-$04` to variables named like `zp_arg0` to
-`zp_arg4`. These memory arguments can then be considered like this:
-
-1. It's up to the caller to save values from these addresses if they are to be
- preserved across calls. The called function might change these values during its
- execution.
-2. The called function can save to `zp_arg0` the returned value, and also to
- `zp_arg1` if the returned value is 16 bit (little endian). In any case, and
- as always, read the documentation for it.
+`zp_arg4`. These memory arguments can then be consumed/owned in different
+ways. In any case, be consistent and document this clearly on each function.
## Using the `x` or `y` registers for code that has to "select"