Is there anything more up-to-date than the how-it-works documentation?

fruviad · December 26, 2019, 02:04

I found some interesting information in the "how-it-works" file, found under /docs/hacking, and also at:

https://angband.readthedocs.io/en/la...-it-works.html

Then I realized that this documentation is referring the reader to files that were removed back in 2015 (e.g. dungeon.c).

Are the broad outlines of that doc still valid, or should it be ignored completely? Is there an updated document that one should focus on, instead?

Nick · December 26, 2019, 02:22

The information in that file is not too bad as far as it goes, but it is massively incomplete and some of the detail (like dungeon.c - now essentially replaced with game-world.c) is incorrect.

There is not really a better document, either - unless you regard the source files themselves as documentation

Sadly, documentation always takes third place to bug-fixing and feature implementation. I have filed it as something to do in 4.2.x.

RicardoGz2019 · January 11, 2020, 02:32

how unfortunate

Pete Mack · January 11, 2020, 05:25

Ricardo--that document wasn't ever worth much. The comments at the beginning of the c files (when present) tend to be better. You are better off firing up a debug build and watching the control flow. Or just reading code.

December 26, 2019, 02:04	#1
fruviad Apprentice Join Date: Jan 2011 Posts: 53	Is there anything more up-to-date than the how-it-works documentation? I found some interesting information in the "how-it-works" file, found under /docs/hacking, and also at: https://angband.readthedocs.io/en/la...-it-works.html Then I realized that this documentation is referring the reader to files that were removed back in 2015 (e.g. dungeon.c). Are the broad outlines of that doc still valid, or should it be ignored completely? Is there an updated document that one should focus on, instead?

December 26, 2019, 02:22	#2
Nick Vanilla maintainer Join Date: Apr 2007 Location: Canberra, Australia Age: 55 Posts: 8,668 Donated: $60	The information in that file is not too bad as far as it goes, but it is massively incomplete and some of the detail (like dungeon.c - now essentially replaced with game-world.c) is incorrect. There is not really a better document, either - unless you regard the source files themselves as documentation Sadly, documentation always takes third place to bug-fixing and feature implementation. I have filed it as something to do in 4.2.x. __________________ One for the Dark Lord on his dark throne In the Land of Mordor where the Shadows lie.

Thread Tools
Show Printable Version Email this Page
Display Modes
Linear Mode Switch to Hybrid Mode Switch to Threaded Mode

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
prf documentation	tumbleweed	Vanilla	24	June 20, 2015 17:39
Out of Date Artefact descriptions	Ed_47569	Vanilla	4	November 15, 2012 14:02
Keymap documentation?	Timo Pietilä	Development	11	June 2, 2011 17:46
[FA] Give me a date !	Arralen	Variants	5	April 6, 2009 02:33
[Un] Restuffing the documentation	Bandobras	Variants	39	March 2, 2008 07:02

January 11, 2020, 02:32	#3
RicardoGz2019 Rookie Join Date: Jan 2020 Posts: 1	how unfortunate

January 11, 2020, 05:25	#4
Pete Mack Prophet Join Date: Apr 2007 Location: Seattle, WA Posts: 5,999 Donated: $40	Ricardo--that document wasn't ever worth much. The comments at the beginning of the c files (when present) tend to be better. You are better off firing up a debug build and watching the control flow. Or just reading code.

Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)