Opened 8 months ago

Closed 3 weeks ago

#28005 closed Cleanup/optimization (wontfix)

normalize usage of terms 'argument' and 'parameter'

Reported by: Sergey Fedoseev Owned by: Levi Payne
Component: Documentation Version: master
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 Changed 8 months ago by Tim Graham

Easy pickings: set
Triage Stage: UnreviewedAccepted

comment:2 Changed 8 months ago by Damir Rakhimov

Owner: changed from nobody to Damir Rakhimov
Status: newassigned

comment:3 Changed 7 months ago by Damir Rakhimov

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

* The ``weak`` argument to ``django.dispatch.signals.Signal.disconnect()`` will
  be removed.

to

* The ``weak`` parameter of ``django.dispatch.signals.Signal.disconnect()`` will
  be removed.

* The ``host`` argument to ``assertsRedirects`` will be removed.

to

* The ``host`` parameter of ``assertsRedirects`` will be removed.

and similar ?

comment:4 Changed 7 months ago by Damir Rakhimov

Owner: Damir Rakhimov deleted
Status: assignednew

comment:5 Changed 7 months ago by ChillarAnand

Owner: set to ChillarAnand
Status: newassigned

comment:6 Changed 3 months ago by lachilles

Owner: changed from ChillarAnand to lachilles

Will give this a try at Djangocon2017 today!

comment:7 Changed 5 weeks ago by Levi Payne

Owner: changed from lachilles to Levi Payne

comment:8 Changed 5 weeks ago by Tim Graham

Has patch: set

comment:9 Changed 5 weeks ago by Levi Payne

Owner: Levi Payne deleted
Status: assignednew

comment:10 Changed 5 weeks ago by Levi Payne

Owner: set to Levi Payne
Status: newassigned

Oh, I see the pull request was abandoned? I can try to finish it up.

comment:11 Changed 5 weeks ago by Tim Graham

The pull request needs to be reviewed. If it looks fine, you can mark the ticket as "Ready for checkin".

comment:12 Changed 5 weeks ago by Levi Payne

Patch needs improvement: set

Current PR is incomplete. Working on a new one that incorporates the changes made so far.

comment:13 Changed 5 weeks ago by Levi Payne

Patch needs improvement: unset

comment:14 Changed 3 weeks ago by Tim Graham

Resolution: wontfix
Status: assignedclosed

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.

Note: See TracTickets for help on using tickets.
Back to Top