[Bf-blender-cvs] [1cc37fd] tmp-id-users: Edits to the docstring

[Campbell Barton]

Commit: 1cc37fd7b76627f6bd4b82ed7c7fc2a7974b31c2
Author: Campbell Barton
Date:   Thu Jan 7 03:49:56 2016 +1100
Branches: tmp-id-users
https://developer.blender.org/rB1cc37fd7b76627f6bd4b82ed7c7fc2a7974b31c2

Edits to the docstring

===================================================================

M	source/blender/python/intern/bpy_rna_id_collection.c

===================================================================

diff --git a/source/blender/python/intern/bpy_rna_id_collection.c b/source/blender/python/intern/bpy_rna_id_collection.c
index 9b570a8..01a4402 100644
--- a/source/blender/python/intern/bpy_rna_id_collection.c
+++ b/source/blender/python/intern/bpy_rna_id_collection.c
@@ -105,15 +105,12 @@ static bool foreach_libblock_id_user_map_callback(void *user_data, ID **id_p, in
 PyDoc_STRVAR(bpy_user_map_doc,
 ".. method:: user_map([subset=(id1, id2, ...)])\n"
 "\n"
-"   Returns a dict mapping all ID datablocks in current bpy.data (or the subset matching\n"
-"   given IDs as optional parameters) to a set of all datablocks using them.\n"
+"   Returns a mapping all ID datablocks in current ``bpy.data`` to a set of all datablocks using them.\n"
 "\n"
-"   WARNING: The keys and items of returned dict use ID themselves, not their names.\n"
-"            This means the dict will likely become invalid after undo/redo and other operations\n"
-"            affecting Blender's internal database."
-"\n"
-"   :arg subset: An iterable of datablocks to search for.\n"
-"   :type subset: iterable\n"
+"   :arg subset: When passed, only data-blocks referencing these will be included as keys in the map.\n"
+"   :type subset: sequence\n"
+"   :return: dictionary of :class:`bpy.types.ID` instances, with sets of ID's as their values.\n"
+"   :rtype: dict\n"
 );
 static PyObject *bpy_user_map(PyObject *UNUSED(self), PyObject *args, PyObject *kwds)
 {