From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 16 Jun 2018 03:46:30 +0000 (-0700)
Subject: bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687)
X-Git-Tag: v3.7.1rc1~410
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5a0bf74d4ec11a246b401896cbfb2e840c13da40;p=python

bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687)


Update the the signature in the code example to make `_cache` a keyword-only parameter.
(cherry picked from commit 2707e41a5c7ede30349cc7dbd66f8be564965d7c)

Co-authored-by: Noah Haasis <haasis_noah@yahoo.de>
---

diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
index d986ab642b..53f3b7f528 100644
--- a/Doc/faq/programming.rst
+++ b/Doc/faq/programming.rst
@@ -371,8 +371,8 @@ compute, a common technique is to cache the parameters and the resulting value
 of each call to the function, and return the cached value if the same value is
 requested again.  This is called "memoizing", and can be implemented like this::
 
-   # Callers will never provide a third parameter for this function.
-   def expensive(arg1, arg2, _cache={}):
+   # Callers can only provide two parameters and optionally pass _cache by keyword
+   def expensive(arg1, arg2, *, _cache={}):
        if (arg1, arg2) in _cache:
            return _cache[(arg1, arg2)]