[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Raymond Hettinger
Raymond Hettinger added the comment: I've applied this PR but still am not sure that it makes readers better-off. -- resolution: -> fixed status: open -> closed ___ Python tracker

[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Géry
Géry added the comment: > Elsewhere in the docs, all the links to this entry use the markup, > :func:`super` which looks nicer in the docs than the class reference. I was suggesting only to update the block Sphinx directive “.. function::” to “.. class::” for defining the signature (so that

[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Raymond Hettinger
Raymond Hettinger added the comment: Also, the related text uses callable terminology, "it returns object that ...". -- ___ Python tracker ___

[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Géry
Géry added the comment: > Looking again, it seems to someone has already started applying class markup > despite previous decisions not to do so. Yes, and he forgot super: class bool([x]) class bytearray([source[, encoding[, errors]]]) class bytes([source[, encoding[, errors]]]) class

[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Raymond Hettinger
Raymond Hettinger added the comment: -0 on doing this. While class markup has crept into the Built-in Functions section, super() isn't really used this way (people don't subclass it or run isinstance on it). Elsewhere in the docs, all the links to this entry use the markup, :func:`super`

[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Raymond Hettinger
Raymond Hettinger added the comment: Looking again, it seems to someone has already started applying class markup despite previous decisions not to do so. -- resolution: rejected -> status: closed -> open versions: -Python 3.6, Python 3.7, Python 3.8

[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Raymond Hettinger
Raymond Hettinger added the comment: In general, we've decided not to do this. We use function mark-up in the section on builtin functions even though many of these are actually types. We use class markup in other sections because that markup is well suited to listing all the associated

[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Géry
Change by Géry : -- keywords: +patch pull_requests: +24212 stage: -> patch review pull_request: https://github.com/python/cpython/pull/25489 ___ Python tracker ___

[issue43896] Update the Sphinx directive for super from function to class

2021-04-20 Thread Géry
New submission from Géry : This PR updates the page [*Built-in Functions*](https://docs.python.org/3.9/library/functions.html#super) of the Python library documentation: `super` is not a `function` (`isinstance(super, type(lambda: None))` is `False`), it is a `type` (`isinstance(super, type)`