[issue27577] Make implementation and doc of tuple and list more compliant

[Xiang Zhang]

Changes by Xiang Zhang :


--
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Xiang Zhang]

Xiang Zhang added the comment:

This issue doesn't make any sense once #29695 is applied. So close.

--
resolution:  -> fixed
stage:  -> resolved

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

I would prefer deprecating keyword parameter for list() and tuple(). It is not 
documented and unlikely used in third party code.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Xiang Zhang]

Xiang Zhang added the comment:

Nice to know your opinions. :) Adjust the patch to use Terry's sentence.

--
components: +Documentation -Interpreter Core
Added file: 
http://bugs.python.org/file43934/tuple_and_list_parameter_name_v2.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Terry J. Reedy]

Terry J. Reedy added the comment:

I agree with Raymond's comments.  No 'note', and once in each doc.  Perhaps 
'for __ and __, the actual name of parameter 'iterable' is still 'sequence'.  
('Still' would be appropriate if the functions predate iterables.)

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Raymond Hettinger]

Raymond Hettinger added the comment:

Can you limit the doc change to just a single occurrence for list and tuple.  
I'm averse to filling docs with redundant, noisy notes over a very minor nuance 
that is more of a curiosity than an actual issue.  Also, can you inline the 
text rather than using the ..note directive which adds more visual clutter than 
is warranted for something so minor.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Xiang Zhang]

Xiang Zhang added the comment:

Thanks for replies. Attach a small documentation patch.

--
keywords: +patch
Added file: http://bugs.python.org/file43844/tuple_and_list_parameter_name.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Raymond Hettinger]

Raymond Hettinger added the comment:

This should have been changed in Python 3.0 which is when were allowed to make 
non-backwards compatible changes.  Since it wasn't, we have to live this mild 
annoyance forever (you can't change it without breaking somebody's working code 
somewhere).

I'm open to a small documentation patch that indicates that the actual keyword 
is "sequence" but the main entry of list(iterable) should remain because it is 
more descriptive of the kind of argument that is allowed.

--
assignee:  -> rhettinger
nosy: +rhettinger

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Terry J. Reedy]

Terry J. Reedy added the comment:

>>> help(tuple)
Help on class tuple in module builtins:

class tuple(object)
 |  tuple() -> empty tuple
 |  tuple(iterable) -> tuple initialized from iterable's items
...
>>> tuple(sequence=[1,2,3])
(1, 2, 3)

I am surprised.  Searches with Google, Githup, Nullage turned up no example of 
such usage.  'tuple(sequence)' has, rather naturally, been used.

--
nosy: +terry.reedy

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27577] Make implementation and doc of tuple and list more compliant

[Xiang Zhang]

Changes by Xiang Zhang :


--
title: tuple and list parameter name conflicts between doc and implementation 
-> Make implementation and doc of tuple and list more compliant

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com