simon-git: puzzles (main): Simon Tatham

[Commits to Tartarus hosted VCS]

TL;DR:
  89391ba Update the developer documentation.

Repository:     https://git.tartarus.org/simon/puzzles.git
On the web:     https://git.tartarus.org/?p=simon/puzzles.git
Branch updated: main
Committer:      Simon Tatham <anakin at pobox.com>
Date:           2022-07-31 15:35:43

commit 89391ba66a2fd3826e16dc288eaa1a1516b1e9de
web diff https://git.tartarus.org/?p=simon/puzzles.git;a=commitdiff;h=89391ba66a2fd3826e16dc288eaa1a1516b1e9de;hp=b34f8b1ee33163af988c75587e6ac99739b7684f
Author: Simon Tatham <anakin at pobox.com>
Date:   Sun Jul 31 13:48:42 2022 +0100

    Update the developer documentation.
    
    It's got a bit out of date over the years, with some changes to the
    code not fully reflected in it (e.g. not all the int -> bool type
    changes were documented, and TRUE and FALSE were still mentioned),
    and quite a lot of new functions not added. (In particular, the dsf
    API was not documented, and it certainly should have been, if only so
    that people can find out what it even stands for!)
    
    As well as correcting for factual accuracy, two content changes in the
    advice chapter:
    
    I've reworded the definition of 'fairness' to explicitly mention that
    requiring the player to use Undo is cheating. That's always how I
    _intended_ the definition, but I didn't say it clearly enough.
    
    And I've added an entire new section describing the normal sensible
    way to implement redraw(), via a loop of the form 'work out what this
    cell should look like, check it against an array in game_drawstate of
    the last state we drew it in, and if they're different, call a redraw
    function'. That was mentioned in passing in two other sections, but I
    know at least one developer didn't find it, so now it's less well
    hidden.

 devel.but | 1104 ++++++++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 908 insertions(+), 196 deletions(-)