New submission from Michael Wayne Goodman <goodman....@gmail.com>:

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?

----------
assignee: docs@python
components: Documentation
messages: 404342
nosy: docs@python, goodmami
priority: normal
severity: normal
status: open
title: mmap: constants not listed in the documentation
versions: Python 3.10, Python 3.11, Python 3.6, Python 3.7, Python 3.8, Python 
3.9

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

Reply via email to