From: Zac Medico <zmedico@gentoo.org>
Date: Wed, 25 Jun 2008 22:49:32 +0000 (-0000)
Subject: Add docstring to slot_dict_class().
X-Git-Tag: v2.2_rc2~327
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=1eb3edfc4581ada94619749546f8b83ae61e0d4a;p=portage.git

Add docstring to slot_dict_class().

svn path=/main/trunk/; revision=10794
---

diff --git a/pym/portage/cache/mappings.py b/pym/portage/cache/mappings.py
index 118592597..c09760fb0 100644
--- a/pym/portage/cache/mappings.py
+++ b/pym/portage/cache/mappings.py
@@ -105,6 +105,17 @@ class LazyLoad(UserDict.DictMixin):
 _slot_dict_classes = weakref.WeakValueDictionary()
 
 def slot_dict_class(keys):
+	"""
+	Generates mapping classes that behave similar to a dict but store values
+	as object attributes that are allocated via __slots__. Instances of these
+	objects have a smaller memory footprint than a normal dict object.
+
+	@param keys: Fixed set of allowed keys
+	@type keys: iterable
+	@rtype: SlotDict
+	@returns: A class that constructs SlotDict instances
+		having the specified keys.
+	"""
 	if isinstance(keys, frozenset):
 		keys_set = keys
 	else: