[issue21575] list.sort() should show arguments in tutorial

2014-06-29 Thread Ezio Melotti

Changes by Ezio Melotti ezio.melo...@gmail.com:


--
stage:  - resolved
type:  - enhancement

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-26 Thread Jan-Philip Gehrcke

Jan-Philip Gehrcke added the comment:

I have updated the patch with a cross-reference to the sorted() built-in, which 
explains the arguments.

W.r.t. to Éric's suggestion: the sorted() doc refers to the sorting howto in 
the wiki. Now everything is connected.

--
Added file: http://bugs.python.org/file35365/sort_tut_02.diff

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-26 Thread Raymond Hettinger

Changes by Raymond Hettinger raymond.hettin...@gmail.com:


--
assignee: docs@python - rhettinger

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-26 Thread Roundup Robot

Roundup Robot added the comment:

New changeset 1b96949bfc97 by Raymond Hettinger in branch 'default':
Issue 21575:  Show list.sort() arguments in the tutorial.
http://hg.python.org/cpython/rev/1b96949bfc97

--
nosy: +python-dev

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-26 Thread Roundup Robot

Roundup Robot added the comment:

New changeset be77b213ace0 by Raymond Hettinger in branch '2.7':
Issue 21575:  Show list.sort() arguments in the tutorial.
http://hg.python.org/cpython/rev/be77b213ace0

--

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-26 Thread Raymond Hettinger

Changes by Raymond Hettinger raymond.hettin...@gmail.com:


--
resolution:  - fixed
status: open - closed

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-25 Thread Jan-Philip Gehrcke

New submission from Jan-Philip Gehrcke:

Currently, the tutorial for the list sort method does not show allowed 
arguments:


list.sort()
Sort the items of the list in place.

(see e.g. https://docs.python.org/3.4/tutorial/datastructures.html)

Is there a reason why we do not show the arguments there? For simplicity? One 
should note that a web search for Python's list methods ranks that page pretty 
high. We could list the defaults, as in the built-in help:

 L.sort(cmp=None, key=None, reverse=False)

And could link to https://docs.python.org/2/library/functions.html#sorted for 
an explanation.

--
assignee: docs@python
components: Documentation
messages: 219085
nosy: docs@python, eric.araujo, ezio.melotti, georg.brandl, jgehrcke
priority: normal
severity: normal
status: open
title: list.sort() should show arguments in tutorial
versions: Python 2.7, Python 3.4, Python 3.5

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-25 Thread Éric Araujo

Éric Araujo added the comment:

I assume it is on purpose that the tutorial does not show all methods with all 
their arguments.  It could overwhelm readers with too much information, and 
would also duplicate the full doc that’s in the reference.

A link from this tutorial page to the list reference (and maybe the sorting 
howto) could be a good addition.

--

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-25 Thread Raymond Hettinger

Raymond Hettinger added the comment:

 Is there a reason why we do not show the arguments there?

It was likely an oversight.   I think it should be updated so that people know 
the options are there.

--
nosy: +rhettinger

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



[issue21575] list.sort() should show arguments in tutorial

2014-05-25 Thread Raymond Hettinger

Changes by Raymond Hettinger raymond.hettin...@gmail.com:


--
keywords: +patch
Added file: http://bugs.python.org/file35358/sort_tut.diff

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