multiprocessing.log_to_stderr missing documentation for parameter

[AlexanderWells-diamond]

BPO	45604
Nosy	@ambv, @miss-islington, @sobolevn, @AlexanderWells-diamond
PRs	bpo-45604: add level argument to multiprocessing.log_to_stderr func #29226 [3.10] bpo-45604: add level argument to multiprocessing.log_to_stderr func (GH-29226) #29283 [3.9] bpo-45604: add level argument to multiprocessing.log_to_stderr func (GH-29226) #29284

^{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 2021-10-28.20:04:18.699>
created_at = <Date 2021-10-25.14:34:49.545>
labels = ['3.11', 'type-feature', '3.9', '3.10', 'docs']
title = 'multiprocessing.log_to_stderr missing documentation for parameter'
updated_at = <Date 2021-10-29.05:53:38.027>
user = 'https://github.com/AlexanderWells-diamond'

bugs.python.org fields:

activity = <Date 2021-10-29.05:53:38.027>
actor = 'sobolevn'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-10-28.20:04:18.699>
closer = 'lukasz.langa'
components = ['Documentation']
creation = <Date 2021-10-25.14:34:49.545>
creator = 'AlexWells'
dependencies = []
files = []
hgrepos = []
issue_num = 45604
keywords = ['patch']
message_count = 6.0
messages = ['404965', '405237', '405251', '405254', '405255', '405286']
nosy_count = 5.0
nosy_names = ['docs@python', 'lukasz.langa', 'miss-islington', 'sobolevn', 'AlexWells']
pr_nums = ['29226', '29283', '29284']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45604'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

[AlexanderWells-diamond]

The documentation for multiprocessing.log_to_stderr() specifies that the method takes no parameters. However, intellisense in VSCode and debugging the method both show that there is a single parameter, "level", whose default value is None.
Documentation here:
https://docs.python.org/3.7/library/multiprocessing.html#multiprocessing.log_to_stderr

The parameter appears to be a shorthand to allow you to both get the logger and specify the required log level in one step, rather than two. The code that handles the "level" parameter appears to do what I'd expect it to do.

I think the documentation simply needs a few words written about the parameter.

Thanks.

[ambv]

New changeset 1fb968c by Nikita Sobolev in branch 'main':
bpo-45604: add level argument to multiprocessing.log_to_stderr func (GH-29226)
1fb968c

[ambv]

New changeset fb80aed by Miss Islington (bot) in branch '3.10':
bpo-45604: add level argument to multiprocessing.log_to_stderr func (GH-29226) (GH-29283)
fb80aed

[ambv]

New changeset 01d11b1 by Miss Islington (bot) in branch '3.9':
bpo-45604: add level argument to multiprocessing.log_to_stderr func (GH-29226) (GH-29284)
01d11b1

[ambv]

Thanks, Nikita! ✨ 🍰 ✨

[sobolevn]

Thanks, Łukasz!

чт, 28 окт. 2021 г. в 23:04, Łukasz Langa <report@bugs.python.org>:

Change by Łukasz Langa <lukasz@langa.pl>:

----------
resolution: -> fixed
stage: patch review -> resolved
status: open -> closed
versions: +Python 3.10, Python 3.11, Python 3.9 -Python 3.7

---

Python tracker <report@bugs.python.org>
<https://bugs.python.org/issue45604\>

---