This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: doc Move comment about list sorting behavour outside impl-detail directive
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.8, Python 3.7, Python 3.6, Python 2.7
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: docs@python Nosy List: adelfino, docs@python, rhettinger
Priority: normal Keywords: patch

Created on 2018-08-28 15:31 by adelfino, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 8976 closed adelfino, 2018-08-28 15:33
Messages (2)
msg324259 - (view) Author: Andrés Delfino (adelfino) * (Python triager) Date: 2018-08-28 15:31
As this text is phrased:

CPython implementation detail: While a list is being sorted, the effect of attempting to mutate, or even inspect, the list is undefined. The C implementation of Python makes the list appear empty for the duration, and raises ValueError if it can detect that the list has been mutated during a sort.

I take it that the first sentence is a general comment for all implementations, as the second sentence does define a specific behavior in CPython, so it's not undefined there.

I propose taking the first sentence out of the impl-detail directive.
msg324270 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2018-08-28 18:12
The sentence should be left as-is.  It is there to make the following two sentences more intelligible.

The docs otherwise make no promises about other implementations and this is as it should be.
History
Date User Action Args
2022-04-11 14:59:05adminsetgithub: 78712
2018-08-28 18:12:08rhettingersetstatus: open -> closed

nosy: + rhettinger
messages: + msg324270

resolution: rejected
stage: patch review -> resolved
2018-08-28 15:33:39adelfinosetkeywords: + patch
stage: patch review
pull_requests: + pull_request8450
2018-08-28 15:31:27adelfinocreate