[docs] solidify argument/parameter terminology (issue 15990)
ezio.melotti at gmail.com
ezio.melotti at gmail.com
Wed Nov 28 06:14:27 CET 2012
http://bugs.python.org/review/15990/diff/6665/Doc/glossary.rst
File Doc/glossary.rst (right):
http://bugs.python.org/review/15990/diff/6665/Doc/glossary.rst#newcode47
Doc/glossary.rst:47: ``name=``) in the calling syntax or passed as a
value in a dictionary
On 2012/11/28 03:25:03, cjerdonek wrote:
> On 2012/11/26 22:04:35, ezio.melotti wrote:
> > s/in the calling syntax/in a function call/?
> > For consistency with the next definition you should use "and/or"
here too.
>
> "and/or" doesn't fit here because "argument" is singular. You would
never have
> an argument that is both preceded by an identifier and occurring as a
value.
> The situation is different below because it discusses multiple
positional
> arguments -- some of which can appear at the beginning and others in
the
> iterable. I used plural arguments below because I did not want to
give the
> impression that a positional argument can occur only at the very
beginning.
> Multiple positional arguments can appear at the beginning of the
argument list.
OK
http://bugs.python.org/review/15990/diff/6665/Doc/glossary.rst#newcode571
Doc/glossary.rst:571: :term:`keyword argument`. This is the default
kind of parameter, for
On 2012/11/28 03:25:03, cjerdonek wrote:
> On 2012/11/26 22:04:35, ezio.melotti wrote:
> > I wouldn't link to positional/keyowrd arguments now that they are
dummy. If
> > linking to argument is too "vague" you /could/ add references before
the two
> > definitions of argument.
>
> I will just link them to "argument" so the reader can still know they
are
> separately defined.
OK
http://bugs.python.org/review/15990/diff/6665/Doc/glossary.rst#newcode605
Doc/glossary.rst:605: :ref:`function` section, and :pep:`362`.
On 2012/11/28 03:25:03, cjerdonek wrote:
> On 2012/11/26 22:04:35, ezio.melotti wrote:
> > It occurred to me that there's another distinction that can be made:
required
> vs
> > optional. Should we add this too?
>
> I mentioned them but do not feel more detail should be added here.
Perhaps a
> question could be added to the FAQ on how to specify that arguments be
optional
> vs. required. But that should be done as part of a different issue.
Adding a separate FAQ just after the one about args vs params SGTM. If
you think details shouldn't be added here it's OK, but there should be
at least a link to this FAQ too.
Feel free to address this in a separate issue.
http://bugs.python.org/review/15990/
More information about the docs
mailing list