[issue34612] doc Some classes are treated as functions in Built-in Functions

[Raymond Hettinger]

Raymond Hettinger  added the comment:

I concur with Eric.  These were marked as functions in the function section of 
the docs.  Their role as classes is noted in the body.  And their role as 
complete classes with a listing of their methods is documented elsewhere.

--
nosy: +rhettinger
resolution:  -> rejected
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34612] doc Some classes are treated as functions in Built-in Functions

[Eric V. Smith]

Eric V. Smith  added the comment:

Ah, you're correct. I just looked for the word "class" inside the "int" text, 
and it doesn't appear there: I thought it was deliberately left out. But it 
does show up in the sub-section header (before "int" itself). Sorry about that.

The text changes look good, then. I don't know enough about Sphinx to know how 
changing the meta-data affects things.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34612] doc Some classes are treated as functions in Built-in Functions

[Andrés Delfino]

Andrés Delfino  added the comment:

Please note that several classes are marked as such (e.g., int, float, str, 
dict, list) and bool for example treats itself as a class in it's description.

Perhaps your concerns applies to all those ocurrences too?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34612] doc Some classes are treated as functions in Built-in Functions

[Eric V. Smith]

Eric V. Smith  added the comment:

I'm not sure this is an improvement. While it's true that 'complex' is a class, 
it's described here as a function. Same as 'int'. The fact that it's a function 
or class isn't so important here.

I suspect it will confuse people to have something described as a class in the 
section titled 'Built-in Functions'. We wouldn't want to change the section to 
the more correct 'Built-in Callables'.

--
nosy: +eric.smith

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34612] doc Some classes are treated as functions in Built-in Functions

[Andrés Delfino]

Change by Andrés Delfino :


--
keywords: +patch
pull_requests: +8572
stage:  -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue34612] doc Some classes are treated as functions in Built-in Functions

[Andrés Delfino]

New submission from Andrés Delfino :

Beyond other classes documented as functions (classmethod, enumerate, filter, 
map, reversed, staticmethod, super and zip), the following issues exist:

* memoryview, range, and tuple are marked as functions
* complex and object treat themselves as functions in their descriptions

Attached PR fixes this.

--
assignee: docs@python
components: Documentation
messages: 324864
nosy: adelfino, docs@python
priority: normal
severity: normal
status: open
title: doc Some classes are treated as functions in Built-in Functions
type: enhancement
versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com