Skip to content

Conversation

@goodmami
Copy link
Contributor

@goodmami goodmami commented Oct 19, 2021

This adds some constants in the mmap module to the documentation. Previously they were (mostly) mentioned but not listed as part of the module contents.

The first commit only adds the lists of constants with some notes about applicability and availability. Prior to merging, there are a few things that could be improved:

  • Update the prose is the relevant method descriptions (e.g., create links to the constant sections)
  • Verify the availability of the constants (e.g., that PROT_* are only available on Unix)
  • Provide descriptions, and possibly a section header, for ALLOCATIONGRANULARITY and PAGESIZE

Also, this PR also adds my name to Misc/ACKS, although it is my third contribution.

https://bugs.python.org/issue45528

* add Michael Wayne Goodman to Misc/ACKS
@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Nov 21, 2021
@MaxwellDupre
Copy link
Contributor

The bug Issue45528 contains suggestions for adding some descriptions, but I don't see them added here; eg:
Update descriptions in mmap.mmap
Provide descriptions for ALLOCATIONGRANULARITY and PAGESIZE

@goodmami
Copy link
Contributor Author

goodmami commented Mar 9, 2022

@MaxwellDupre Thanks! Those are my comments in issue45528 and repeated in this PR. I was hoping to get some feedback to resolve my uncertainty before committing the updates, but it never came and the PR languished. Any suggestions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review stale Stale PR or inactive for long period of time.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants