This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author goodmami
Recipients docs@python, goodmami
Date 2021-10-19.19:32:50
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1634671970.69.0.866952550683.issue45528@roundup.psfhosted.org>
In-reply-to
Content
Some constants mentioned in the mmap module documentation are not listed as module contents (i.e., with permalinks), so the mentions do not appear as links and it's not explicit that they are in the mmap module namespace. For instance, ACCESS_READ is referenced but does not link to anything, whereas MAP_PRIVATE links to the MAP_* constants section below showing that it is available as mmap.MAP_PRIVATE.

Constants available but not listed:

* ACCESS_* constants
  - ACCESS_READ
  - ACCESS_WRITE
  - ACCESS_COPY
  - ACCESS_DEFAULT
* PROT_* constants
  - PROT_READ
  - PROT_WRITE
  - PROT_EXEC (this one isn't even mentioned in the docs)
* ALLOCATIONGRANULARITY
* PAGESIZE

These constants are available and unlisted in the documentation for all active versions of Python (except ACCESS_DEFAULT, which is available from 3.7). In addition, none of the MAP_* constants are listed for Python 3.9 and prior, although they all (except MAP_POPULATE) have been available since at least 3.6.

Since these are valid and available constants in the mmap module, can we list them in the documentation for the appropriate versions?
History
Date User Action Args
2021-10-19 19:32:50goodmamisetrecipients: + goodmami, docs@python
2021-10-19 19:32:50goodmamisetmessageid: <1634671970.69.0.866952550683.issue45528@roundup.psfhosted.org>
2021-10-19 19:32:50goodmamilinkissue45528 messages
2021-10-19 19:32:50goodmamicreate