[New-bugs-announce] [issue40576] Align docs for list.sort, sorted, and on the website

Sam Lijin report at bugs.python.org
Sat May 9 06:30:31 EDT 2020


New submission from Sam Lijin <python at sxlijin.com>:

It's mildly confusing to see `pydoc sorted` and `pydoc list.sort` to look so different, esp. since sorted just delegates to list.sort.

By extension, https://docs.python.org/3/library/functions.html#sorted should also be aligned with this, but I'm not super familiar with what the distinction content in the docstrings and the website is intended to be, if there is any guiding philosophy there.

sorted() appears to have been documented as an afterthought as part of this commit:
https://github.com/python/cpython/commit/f9e227e5a9d7a74393ef259c861660c3d1f36f83

list.sort was last updated in 2018 by https://github.com/python/cpython/pull/8516

I have an incoming PR for this.

----------
assignee: docs at python
components: Documentation
messages: 368508
nosy: docs at python, sxlijin
priority: normal
severity: normal
status: open
title: Align docs for list.sort, sorted, and on the website
type: enhancement
versions: Python 3.9

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue40576>
_______________________________________


More information about the New-bugs-announce mailing list