From 444bed78a9f5068a659756cc5519f34d3094070e Mon Sep 17 00:00:00 2001 From: Pelle Nilsson Date: Tue, 23 Sep 2014 23:29:55 +0200 Subject: [PATCH] Some documentation for verbose checkgamebook.py. --- readme.org | 5 +++++ todo.org | 6 +++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/readme.org b/readme.org index 2fc8fc0..cd9c67a 100644 --- a/readme.org +++ b/readme.org @@ -97,6 +97,11 @@ unlocked because it is impossible to find enough money to pay for a key. Future versions will hopefully catch more problems, but never all of them in complex books. +Run *checkgamebook.py -v* for verbose mode. Currently that just +means that all ending (death?) sections of the book are printed, +allowing you to manually check that there are no unexpected +dead-ends. + ** Number Map Files Whenever formatgamebook.py runs it looks for a file with the same name as the output file, but with a .map suffix (eg output.map if diff --git a/todo.org b/todo.org index 47af07b..5c9e2ab 100644 --- a/todo.org +++ b/todo.org @@ -1,4 +1,4 @@ -* TODO [64/92] [69%] +* TODO [64/93] [68%] ** DONE Debug output ** DONE DOT output ** DONE LaTeX output @@ -181,3 +181,7 @@ listed even if it is not tagged. or treat as any other missing section otherwise. ** TODO checkgamebook.py ignore dummy and fake sections ** TODO checkgamebook.py trace items to find sections they are needed but can not have been found +** TODO tag to generate checkgamebook.py warnings + Some tag that can be set on incomplete sections to trigger warnings + as a reminder that the book is not done yet, and show you what + sections remain to be written.