[Good first-time issue] Recommend keyword-only param for memoization in FAQ

[zware]

BPO	33836
Nosy	@zware, @Mariatta, @miss-islington, @codecamelot
PRs	bpo-33836: Fix code example in the documentation. #7687 [3.7] bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687) #7742 [3.6] bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687) #7743

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2018-06-16.03:34:23.860>
created_at = <Date 2018-06-11.15:59:35.352>
labels = ['easy', '3.7', '3.8', 'docs']
title = '[Good first-time issue] Recommend keyword-only param for memoization in FAQ'
updated_at = <Date 2018-06-16.03:50:30.441>
user = 'https://github.com/zware'

bugs.python.org fields:

activity = <Date 2018-06-16.03:50:30.441>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-06-16.03:34:23.860>
closer = 'Mariatta'
components = ['Documentation']
creation = <Date 2018-06-11.15:59:35.352>
creator = 'zach.ware'
dependencies = []
files = []
hgrepos = []
issue_num = 33836
keywords = ['patch', 'easy']
message_count = 7.0
messages = ['319310', '319437', '319464', '319702', '319704', '319706', '319709']
nosy_count = 5.0
nosy_names = ['docs@python', 'zach.ware', 'Mariatta', 'miss-islington', 'codecamelot']
pr_nums = ['7687', '7742', '7743']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue33836'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']

[zware]

In https://docs.python.org/3/faq/programming.html#why-are-default-values-shared-between-objects there is an example showing memoization using `def expensive(arg1, arg2, _cache={}):`. We should change the signature in that example to make `_cache` a keyword-only parameter and possibly adjust the comment to note that that's been done to prevent accidental calls with three positional arguments.

Note to existing contributors: if this wouldn't be within your first couple of patches, please leave this for a new contributor to find. Thanks!

[codecamelot]

Hey Zach,

Can I get this one? I haven't contributed anything yet.

Cheers,
Jason

[zware]

Certainly! Have a look at the devguide to get started.

[Mariatta]

New changeset 2707e41 by Mariatta (Noah Haasis) in branch 'master':
bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687)
2707e41

[Mariatta]

Thanks!

[miss-islington]

New changeset 5a0bf74 by Miss Islington (bot) in branch '3.7':
bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687)
5a0bf74

[miss-islington]

New changeset 2636833 by Miss Islington (bot) in branch '3.6':
bpo-33836: Recommend keyword-only param for memoization in FAQ (GH-7687)
2636833