[issue19820] docs are missing info about module attributes

[Michael Anckaert]

Change by Michael Anckaert :


--
keywords: +patch
pull_requests: +15071
stage: needs patch -> patch review
pull_request: https://github.com/python/cpython/pull/15359

___
Python tracker 

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

[issue19820] docs are missing info about module attributes

[Michael Anckaert]

Michael Anckaert  added the comment:

@emmanuel: thanks for offering your help. 

I made a first attempt at improving the docs in this branch: 
https://github.com/MichaelAnckaert/cpython/tree/bpo-19820

--

___
Python tracker 

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

[issue19820] docs are missing info about module attributes

[Emmanuel Arias]

Emmanuel Arias  added the comment:

> I can update the docs but I would rely on the comments in Lib/inspect.py on 
> what to include. Executing inspect.getmembers on a module returns a lot more 
> attributes than documented in ismodule.

I can help too.

--
nosy: +eamanu

___
Python tracker 

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

[issue19820] docs are missing info about module attributes

[Eric Snow]

Eric Snow  added the comment:

The relevant module attributes are described in the importlib docs: 
https://docs.python.org/3/library/importlib.html#importlib.abc.Loader.load_module

--
versions: +Python 3.7, Python 3.8, Python 3.9 -Python 3.3, Python 3.4

___
Python tracker 

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

[issue19820] docs are missing info about module attributes

[Michael Anckaert]

Michael Anckaert  added the comment:

As far as I can tell there is at least some information missing from the 'Types 
and members' section. Not all attributes are listed in the table. 

For example the attribute __cached__ is missing from the module type but it is 
documented in the inspect module. 

I can update the docs but I would rely on the comments in Lib/inspect.py on 
what to include. Executing inspect.getmembers on a module returns a lot more 
attributes than documented in ismodule.

--
nosy: +michaelanckaert

___
Python tracker 

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

[issue19820] docs are missing info about module attributes

[M. Anil Tuncel]

M. Anil Tuncel  added the comment:

Are they still missing? inspect.ismodule() seems to be there at least.
https://docs.python.org/3/library/inspect.html

--
nosy: +anilbey

___
Python tracker 

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

[issue19820] docs are missing info about module attributes

[Arfrever Frehtes Taifersar Arahesis]

Changes by Arfrever Frehtes Taifersar Arahesis arfrever@gmail.com:


--
nosy: +Arfrever

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

[issue19820] docs are missing info about module attributes

[Eric Snow]

Changes by Eric Snow ericsnowcurren...@gmail.com:


--
keywords: +easy

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

[issue19820] docs are missing info about module attributes

[Eric Snow]

New submission from Eric Snow:

The docs for the inspect module and the types module do not list all the 
import-related module attributes.  I'm guessing they've been out of sync a 
while.

The docstring for for inspect.ismodule() is likewise missing information.

--
assignee: docs@python
components: Documentation
messages: 204642
nosy: docs@python, eric.snow
priority: low
severity: normal
stage: needs patch
status: open
title: docs are missing info about module attributes
type: enhancement
versions: Python 3.3, Python 3.4

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