[Django] #28005: normalize usage of terms 'argument' and 'parameter'
Django
------------------------------------------------+------------------------
Reporter: Sergey Fedoseev | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
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
--
Ticket URL: <https://code.djangoproject.com/ticket/28005>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: Sergey Fedoseev | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham):
* easy: 0 => 1
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:1>
Django
Reporter: Sergey Fedoseev | Owner: Damir
Type: | Rakhimov
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by Damir Rakhimov):
* owner: nobody => Damir Rakhimov
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:2>
Django
Reporter: Sergey Fedoseev | Owner: Damir
Type: | Rakhimov
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (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:
{{{
* 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 ?
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:3>
Django
Reporter: Sergey Fedoseev | Owner: (none)
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
--------------------------------------+------------------------------------
Changes (by Damir Rakhimov):
* owner: Damir Rakhimov => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:4>
Django
Reporter: Sergey Fedoseev | Owner:
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* owner: (none) => ChillarAnand
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:5>
Django
Reporter: Sergey Fedoseev | Owner: lachilles
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* owner: ChillarAnand => lachilles
Comment:
Will give this a try at Djangocon2017 today!
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:6>
Django
Reporter: Sergey Fedoseev | Owner: Levi
Type: | Payne
Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* owner: lachilles => Levi Payne
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:7>
Django
Reporter: Sergey Fedoseev | Owner: Levi
Type: | Payne
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* has_patch: 0 => 1
Comment:
[https://github.com/django/django/pull/8923 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:8>
Django
Reporter: Sergey Fedoseev | Owner: (none)
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
--------------------------------------+------------------------------------
Changes (by Levi Payne):
* status: assigned => new
* owner: Levi Payne => (none)
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:9>
Django
Reporter: Sergey Fedoseev | Owner: Levi
Type: | Payne
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by Levi Payne):
* owner: (none) => Levi Payne
* status: new => assigned
Comment:
Oh, I see the pull request was abandoned? I can try to finish it up.
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:10>
Django
Reporter: Sergey Fedoseev | Owner: Levi
Type: | Payne
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Comment (by Tim Graham):
The pull request needs to be reviewed. If it looks fine, you can mark the
ticket as "Ready for checkin".
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:11>
Django
Reporter: Sergey Fedoseev | Owner: Levi
Type: | Payne
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
Comment:
Current PR is incomplete. Working on a new one that incorporates the
changes made so far.
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:12>
Django
Reporter: Sergey Fedoseev | Owner: Levi
Type: | Payne
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by Levi Payne):
* needs_better_patch: 1 => 0
Comment:
[https://github.com/django/django/pull/9238 New PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:13>
Django
Reporter: Sergey Fedoseev | Owner: Levi
Type: | Payne
Component: Documentation | Version: master
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => wontfix
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/28005#comment:14>