diff nes.py @ 117:fbb04916a5a7 draft

Tile: add a short docstring I have decided that view-into-ROM is now API, so best to document it.
author Jordi GutiƩrrez Hermoso <jordigh@octave.org>
date Mon, 30 Sep 2019 09:17:40 -0400 (2019-09-30)
parents b52d47e78ff8
children 72c36fb13706
line wrap: on
line diff
--- a/nes.py
+++ b/nes.py
@@ -78,6 +78,13 @@
 
 
 class Tile(object):
+    """
+    A tile is a view into a part of a NES ROM (either its PRG or its
+    CHR). A tile just keeps an index into the ROM position by 16-byte
+    offsets as well as individual palette information for this one
+    view.
+
+    """
 
     default_palette = TILE_PALETTES["Primary"]