From 90bef1a8d5ead539ad84efc186d9183197beca6e Mon Sep 17 00:00:00 2001 From: tajmone Date: Mon, 9 Mar 2015 11:52:26 +0100 Subject: [PATCH] more docstrings more docstrings --- evennia/utils/dbserialize.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/evennia/utils/dbserialize.py b/evennia/utils/dbserialize.py index 4208f24288..f5a9e31e8a 100644 --- a/evennia/utils/dbserialize.py +++ b/evennia/utils/dbserialize.py @@ -10,11 +10,11 @@ The purpose of dbserialize is to handle all forms of data. For well-structured non-arbitrary exchange, such as communicating with a rich web client, a simpler JSON serialization makes more sense. -This module also implements the SaverList, SaverDict and SaverSet +This module also implements the `SaverList`, `SaverDict` and `SaverSet` classes. These are iterables that track their position in a nested structure and makes sure to send updates up to their root. This is used by Attributes - without it, one would not be able to update mutables -in-situ, e.g obj.db.mynestedlist[3][5] = 3 would never be saved and +in-situ, e.g `obj.db.mynestedlist[3][5] = 3` would never be saved and be out of sync with the database. """