From: Zackery Spytz <zspytz@gmail.com>
Date: Tue, 11 Sep 2018 04:37:33 +0000 (-0600)
Subject: bpo-33032: Mention the implicit cache in struct.Struct() docs (GH-7700)
X-Git-Tag: v3.8.0a1~1061
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3666b3c1f695a145adab1bf644c22e564e8eb0ee;p=thirdparty%2FPython%2Fcpython.git

bpo-33032: Mention the implicit cache in struct.Struct() docs (GH-7700)

Mention the implicit cache in struct.Struct() docs.

Consistent with the re.compile documentation note.
---

diff --git a/Doc/library/struct.rst b/Doc/library/struct.rst
index d6a3cb721e83..bad33ac666ed 100644
--- a/Doc/library/struct.rst
+++ b/Doc/library/struct.rst
@@ -405,6 +405,12 @@ The :mod:`struct` module also defines the following type:
    methods is more efficient than calling the :mod:`struct` functions with the
    same format since the format string only needs to be compiled once.
 
+   .. note::
+
+      The compiled versions of the most recent format strings passed to
+      :class:`Struct` and the module-level functions are cached, so programs
+      that use only a few format strings needn't worry about reusing a single
+      :class:`Struct` instance.
 
    Compiled Struct objects support the following methods and attributes: