New submission from Delgan <delgan...@gmail.com>:

Hi.

Quick use case explanation about this: I would like to document my function, 
stating that it accepts any "callable" object and linking to a proper 
definition of such object.

For example, I'm already doing this when my function accepts a "file object". 
There exists no such type I can link to, so I link to the glossary definition: 
https://docs.python.org/3/glossary.html#term-file-object

I could link to the "callable()" built-in but than does not reflect well the 
expected *type* of the argument. For now, I define the argument as a "function" 
( https://docs.python.org/3/glossary.html#term-function ) but this is too 
restrictive.

The definition for "callable" would be pretty straightforward, just mentioning 
it should implement "__call__", also linking to "emulating callable object" ( 
https://docs.python.org/3/reference/datamodel.html#emulating-callable-objects ) 
and / or the "callable()" builtin ( 
https://docs.python.org/3/library/functions.html#callable ).

----------
assignee: docs@python
components: Documentation
messages: 357366
nosy: Delgan, docs@python
priority: normal
severity: normal
status: open
title: Add a glossary entry for "callable" objects
versions: Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9

_______________________________________
Python tracker <rep...@bugs.python.org>
<https://bugs.python.org/issue38900>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to