SF bug #655271: Slightly modify locals() doc

rhettinger · rhettinger · commit 69bf8f3f4e28 · 2003-01-04T02:16:22.000Z
Clarify the operation of locals().
diff --git a/Doc/lib/libfuncs.tex b/Doc/lib/libfuncs.tex
@@ -624,7 +624,7 @@ \section{Built-in Functions \label{built-in-funcs}}
 \end{funcdesc}
 
 \begin{funcdesc}{locals}{}
-  Return a dictionary representing the current local symbol table.
+  Update and return a dictionary representing the current local symbol table.
   \warning{The contents of this dictionary should not be modified;
   changes may not affect the values of local variables used by the
   interpreter.}
diff --git a/Python/bltinmodule.c b/Python/bltinmodule.c
@@ -1041,7 +1041,7 @@ builtin_locals(PyObject *self)
 PyDoc_STRVAR(locals_doc,
 "locals() -> dictionary\n\
 \n\
-Return the dictionary containing the current scope's local variables.");
+Update and return a dictionary containing the current scope's local variables.");
 
 
 static PyObject *
