[New-bugs-announce] [issue36908] "This module is always available" is confusing

Ned Batchelder report at bugs.python.org
Mon May 13 17:15:22 EDT 2019


New submission from Ned Batchelder <ned at nedbatchelder.com>:

The math and cmath modules say this in their docs: "This module is always available."  This lead a beginner to believe they didn't need to be imported.

Nearly the entire standard library is always available in this sense (they can be imported).  This sentence isn't useful.

Can we change the first paragraph of the math module to be:

"This module provides access to the mathematical functions defined by the C standard."

(and similarly for the cmath module.)

----------
assignee: docs at python
components: Documentation
messages: 342386
nosy: docs at python, nedbat
priority: normal
severity: normal
status: open
title: "This module is always available" is confusing

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


More information about the New-bugs-announce mailing list