[issue40846] Misleading line in documentation
New submission from J Arun Mani <j.arunmani@protonmail.com>: 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 ^^ ---------- assignee: docs@python components: Documentation messages: 370616 nosy: J Arun Mani, docs@python priority: normal severity: normal status: open title: Misleading line in documentation _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40846> _______________________________________
Rémi Lapeyre <remi.lapeyre@henki.fr> added the comment: 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? ---------- nosy: +remi.lapeyre _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40846> _______________________________________
Jim Fasarakis-Hilliard <d.f.hilliard@gmail.com> added the comment: 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 ---------- nosy: +Jim Fasarakis-Hilliard _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40846> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- keywords: +patch nosy: +python-dev nosy_count: 4.0 -> 5.0 pull_requests: +19830 stage: -> patch review pull_request: https://github.com/python/cpython/pull/20602 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40846> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- pull_requests: +19831 pull_request: https://github.com/python/cpython/pull/20603 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40846> _______________________________________
J Arun Mani <j.arunmani@protonmail.com> added the comment: Hi. Thanks for your follow-up. I created a PR, since I signed CLA today, the PR has some labels indicating it. :p Thanks ---------- nosy: -python-dev _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue40846> _______________________________________
participants (4)
-
J Arun Mani -
Jim Fasarakis-Hilliard
-
Roundup Robot
-
Rémi Lapeyre