[New-bugs-announce] [issue21575] list.sort() should show arguments in tutorial

[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 at python
components: Documentation
messages: 219085
nosy: docs at 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 <report at bugs.python.org>
<http://bugs.python.org/issue21575>
_______________________________________