classification
Title: Misleading line in documentation
Type: Stage: patch review
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: J Arun Mani, Jim Fasarakis-Hilliard, docs@python, remi.lapeyre
Priority: normal Keywords: patch

Created on 2020-06-02 18:23 by J Arun Mani, last changed 2020-06-03 08:43 by J Arun Mani.

Pull Requests
URL Status Linked Edit
PR 20602 closed python-dev, 2020-06-03 08:20
PR 20603 closed python-dev, 2020-06-03 08:39
Messages (4)
msg370616 - (view) Author: J Arun Mani (J Arun Mani) * Date: 2020-06-02 18:23
Hi.

 In docs : https://docs.python.org/3/faq/programming.html#faq-argument-vs-parameter it says "Parameters define what types of arguments a function can accept."
 This is not true. Python's functions do not impose any type checking or raise error when the argument's type is not matching it's type hint. Please change the line to a better one. Maybe "Parameters define the names that will hold the supplied arguments."

Thanks ^^
msg370622 - (view) Author: RĂ©mi Lapeyre (remi.lapeyre) * Date: 2020-06-02 19:28
Hi, thanks for pointing this out.

I think "type" here is not about the type of the object but whether it is:

 - positional-only
 - positional or keyword
 - variadic positional
 - keyword-only
 - variadic keyword


The wording could certainly be improved as it is currently unclear. Could you make a suggestion and open a PR?
msg370624 - (view) Author: Jim Fasarakis-Hilliard (Jim Fasarakis-Hilliard) * Date: 2020-06-02 20:12
A simple substitution of 'types' with 'kind' should do it. This aligns with the terminology [1] used in the glossary.

[1] https://docs.python.org/3/glossary.html#term-parameter
msg370647 - (view) Author: J Arun Mani (J Arun Mani) * Date: 2020-06-03 08:43
Hi. Thanks for your follow-up. I created a PR, since I signed CLA today, the PR has some labels indicating it. :p
Thanks
History
Date User Action Args
2020-06-03 08:43:18J Arun Manisetnosy: - python-dev
messages: + msg370647
2020-06-03 08:39:39python-devsetpull_requests: + pull_request19831
2020-06-03 08:20:08python-devsetkeywords: + patch
nosy: + python-dev

pull_requests: + pull_request19830
stage: patch review
2020-06-02 20:12:39Jim Fasarakis-Hilliardsetnosy: + Jim Fasarakis-Hilliard
messages: + msg370624
2020-06-02 19:28:09remi.lapeyresetnosy: + remi.lapeyre
messages: + msg370622
2020-06-02 18:23:09J Arun Manicreate