[docs] [issue12531] documentation index entries for * and **

Terry J. Reedy report at bugs.python.org
Fri Jul 15 21:25:51 CEST 2011


Terry J. Reedy <tjreedy at udel.edu> added the comment:

This is just the tip of the iceberg as far as needed symbol index entries goes. Nearly 3 years ago, I wrote a Python 3 symbol glossary "Python3 Syntax Symbol Uses" that was complete as far as I knew then. I think most of the entries there should have a corresponding index entry in the official docs. Link to download/view is

https://code.google.com/p/xploro/downloads/detail?name=PySymbols.html&can=1&q=

That has 7 entries for '*':
  *: In function parameter list, make following unstarred names keyword only.
P *parameter_name: Function parameter bound to a tuple of extra positional arguments, any following unstarred names are keyword only.
P *iterable: In a call, unpack iterable items as arguments.
P *assignment_target: Starred target in assignment statement gets extra items from iterable.
I number1 * number2: Number multiplication operator.
I n * sequence or sequence * n: Operator to concatenate n copies of sequence.
S from module import *: Import all public (non-private) names from the module. 

 /P/I/S == 'nofix', prefix, infix, suffix.

I have been planning to work on a patch 'sometime', but would be happy if someone else grabbed the above and ran with it (and expanded the title of this issue).

I believe existing docs can get additions like this.

----------
nosy: +terry.reedy
versions: +Python 2.7, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue12531>
_______________________________________


More information about the docs mailing list