stack_size([size]) is actually stack_size(size=0)

[mattip]

BPO	24952
Nosy	@berkerpeksag, @vadmium, @mattip
Files	stack_size.patch stack_size2.7.patch stack_size.patch: better patch against 3.5 documentation stack_size2.7.patch: better patch against 2.7 documentation

^{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 = 'https://github.com/vadmium'
closed_at = <Date 2015-08-31.03:48:28.267>
created_at = <Date 2015-08-28.14:59:08.065>
labels = ['type-bug', 'docs']
title = 'stack_size([size]) is actually stack_size(size=0)'
updated_at = <Date 2015-08-31.03:48:28.265>
user = 'https://github.com/mattip'

bugs.python.org fields:

activity = <Date 2015-08-31.03:48:28.265>
actor = 'martin.panter'
assignee = 'martin.panter'
closed = True
closed_date = <Date 2015-08-31.03:48:28.267>
closer = 'martin.panter'
components = ['Documentation']
creation = <Date 2015-08-28.14:59:08.065>
creator = 'mattip'
dependencies = []
files = ['40281', '40282', '40304', '40305']
hgrepos = []
issue_num = 24952
keywords = ['patch']
message_count = 8.0
messages = ['249280', '249281', '249302', '249367', '249368', '249376', '249379', '249380']
nosy_count = 5.0
nosy_names = ['docs@python', 'python-dev', 'berker.peksag', 'martin.panter', 'mattip']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue24952'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6']

[mattip]

when using thread.stack_size or threading.stack_size, if no argument is provided the stack size is reset to default. Trivial patch for 3.5 provided

[mattip]

Add a patch for 2.7

[vadmium]

In my mind this notation implies the folowing should work:

>>> threading.stack_size(size=0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: stack_size() takes no keyword arguments

Perhaps you really just want make it more explicit that the special value 0 is used by default if the argument omitted? See also bpo-8706 about supporting named keyword parameters, and bpo-13386 and bpo-23738 about other possible notations to document the default value.

[mattip]

Add the default value 0 to the documentation, please review this patch and not the previous one

[mattip]

Add default value of 0 to documentation for 2.7

[vadmium]

This version looks okay. I’ll commit it when I get a chance.

BTW, there’s no point changing the version for each patch. The version field only applies to the whole bug report.

[python-dev]

New changeset 328383905eaf by Martin Panter <vadmium> in branch '3.4':
Issue bpo-24952: Clarify default argument of stack_size() in threading, _thread
https://hg.python.org/cpython/rev/328383905eaf

New changeset 606082fa2804 by Martin Panter <vadmium> in branch '3.5':
Issue bpo-24952: Merge 3.4 into 3.5
https://hg.python.org/cpython/rev/606082fa2804

New changeset 501c9ab07996 by Martin Panter <vadmium> in branch 'default':
Issue bpo-24952: Merge 3.5 into 3.6
https://hg.python.org/cpython/rev/501c9ab07996

New changeset 79afd50396c5 by Martin Panter <vadmium> in branch '2.7':
Issue bpo-24952: Clarify default argument of stack_size() in threading, thread
https://hg.python.org/cpython/rev/79afd50396c5

[vadmium]

Thanks for the patches