Opened 8 years ago
Closed 7 years ago
#28005 closed Cleanup/optimization (wontfix)
normalize usage of terms 'argument' and 'parameter'
Reported by: | Sergey Fedoseev | Owned by: | Levi Payne |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
https://docs.python.org/3/faq/programming.html#faq-argument-vs-parameter (see for more detailed explanation)
What is the difference between arguments and parameters?
Parameters are defined by the names that appear in a function definition, whereas arguments are the values actually passed to a function when calling it.
Example of incorrect term usage: https://github.com/django/django/blob/6b3724fa1116c0949a6e0cd3e0dd55959a3abd93/docs/releases/2.0.txt#L75
Change History (14)
comment:1 by , 8 years ago
Easy pickings: | set |
---|---|
Triage Stage: | Unreviewed → Accepted |
comment:2 by , 8 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:3 by , 8 years ago
comment:4 by , 8 years ago
Owner: | removed |
---|---|
Status: | assigned → new |
comment:5 by , 8 years ago
Owner: | set to |
---|---|
Status: | new → assigned |
comment:7 by , 7 years ago
Owner: | changed from | to
---|
comment:9 by , 7 years ago
Owner: | removed |
---|---|
Status: | assigned → new |
comment:10 by , 7 years ago
Owner: | set to |
---|---|
Status: | new → assigned |
Oh, I see the pull request was abandoned? I can try to finish it up.
comment:11 by , 7 years ago
The pull request needs to be reviewed. If it looks fine, you can mark the ticket as "Ready for checkin".
comment:12 by , 7 years ago
Patch needs improvement: | set |
---|
Current PR is incomplete. Working on a new one that incorporates the changes made so far.
comment:14 by , 7 years ago
Resolution: | → wontfix |
---|---|
Status: | assigned → closed |
After looking at the large size of the patch, I don't think this is worth it. Changing so much documentation will require non-trivial work for translators and I don't think the current wording is causing any confusion. Practicality seems to trump purity here.
I searched for argument in the docs directory.
Above example in the description should I change argument to parameter in other cases like these:
https://github.com/django/django/blob/6b3724fa1116c0949a6e0cd3e0dd55959a3abd93/docs/internals/deprecation.txt
to
to
and similar ?