From 3e09ac0c10c95bb24a08af62393b4f761e2743d0 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 24 Aug 2013 09:54:45 +0000 Subject: initial commit --- HACKING | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 HACKING (limited to 'HACKING') diff --git a/HACKING b/HACKING new file mode 100644 index 0000000..88b675b --- /dev/null +++ b/HACKING @@ -0,0 +1,12 @@ +serialization (dtas-player) +--------------------------- + +* objects serialize using the "to_hsh" method (like "to_hash", but omits + default values) and then to YAML. We avoid exposing the fact we use + Ruby (or any programming language) in any formats. + +* every serializable class defines a "load" singleton method which takes the + output Hash of "to_hsh" + +* we avoid serializing default values to make the state file shorter and + more suitable for human viewing and editing. -- cgit v1.2.3-24-ge0c7