[New-bugs-announce] [issue34531] doc Move comment about list sorting behavour outside impl-detail directive

[Andrés Delfino]

New submission from Andrés Delfino <adelfino at gmail.com>:

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.

----------
assignee: docs at python
components: Documentation
messages: 324259
nosy: adelfino, docs at python
priority: normal
severity: normal
status: open
title: doc Move comment about list sorting behavour outside impl-detail directive
type: enhancement
versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8

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