Kaydet (Commit) 31e7f50d authored tarafından Martin Panter's avatar Martin Panter

Issue #24952: Clarify default argument of stack_size() in threading, _thread

Patch from Mattip.
üst 0612ffe8
...@@ -93,7 +93,8 @@ It defines the following constants and functions: ...@@ -93,7 +93,8 @@ It defines the following constants and functions:
Return the thread stack size used when creating new threads. The optional Return the thread stack size used when creating new threads. The optional
*size* argument specifies the stack size to be used for subsequently created *size* argument specifies the stack size to be used for subsequently created
threads, and must be 0 (use platform or configured default) or a positive threads, and must be 0 (use platform or configured default) or a positive
integer value of at least 32,768 (32 KiB). If changing the thread stack size is integer value of at least 32,768 (32 KiB). If *size* is not specified,
0 is used. If changing the thread stack size is
unsupported, a :exc:`RuntimeError` is raised. If the specified stack size is unsupported, a :exc:`RuntimeError` is raised. If the specified stack size is
invalid, a :exc:`ValueError` is raised and the stack size is unmodified. 32 KiB invalid, a :exc:`ValueError` is raised and the stack size is unmodified. 32 KiB
is currently the minimum supported stack size value to guarantee sufficient is currently the minimum supported stack size value to guarantee sufficient
......
...@@ -89,7 +89,8 @@ This module defines the following functions: ...@@ -89,7 +89,8 @@ This module defines the following functions:
Return the thread stack size used when creating new threads. The optional Return the thread stack size used when creating new threads. The optional
*size* argument specifies the stack size to be used for subsequently created *size* argument specifies the stack size to be used for subsequently created
threads, and must be 0 (use platform or configured default) or a positive threads, and must be 0 (use platform or configured default) or a positive
integer value of at least 32,768 (32 KiB). If changing the thread stack size is integer value of at least 32,768 (32 KiB). If *size* is not specified,
0 is used. If changing the thread stack size is
unsupported, a :exc:`RuntimeError` is raised. If the specified stack size is unsupported, a :exc:`RuntimeError` is raised. If the specified stack size is
invalid, a :exc:`ValueError` is raised and the stack size is unmodified. 32 KiB invalid, a :exc:`ValueError` is raised and the stack size is unmodified. 32 KiB
is currently the minimum supported stack size value to guarantee sufficient is currently the minimum supported stack size value to guarantee sufficient
......
...@@ -888,6 +888,7 @@ Nick Mathewson ...@@ -888,6 +888,7 @@ Nick Mathewson
Simon Mathieu Simon Mathieu
Laura Matson Laura Matson
Graham Matthews Graham Matthews
mattip
Martin Matusiak Martin Matusiak
Dieter Maurer Dieter Maurer
Daniel May Daniel May
......
...@@ -456,6 +456,9 @@ C API ...@@ -456,6 +456,9 @@ C API
Documentation Documentation
------------- -------------
- Issue #24952: Clarify the default size argument of stack_size() in
the "threading" and "_thread" modules. Patch from Mattip.
- Issue #24808: Update the types of some PyTypeObject fields. Patch by - Issue #24808: Update the types of some PyTypeObject fields. Patch by
Joseph Weston. Joseph Weston.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment