FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-151950: Fix Sphinx references in mmap documentation by Boyeep · Pull Request #153764 · python/cpython · GitHub

Repository navigation

gh-151950: Fix Sphinx references in mmap documentation - #153764

Merged
hugovk merged 2 commits into
python:mainfrom
Boyeep:gh-151950-mmap-sphinx-refs
Oct 21, 2026
Merged

hugovk merged 2 commits into
python:mainfrom
Boyeep:gh-151950-mmap-sphinx-refs

Conversation

Boyeep commented Jul 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fix the unresolved Sphinx references in the mmap documentation by:

  • documenting the access, page-size, and PROT_* constants with data directives;
  • qualifying the mmap.seek reference;
  • correcting the combined PROT_READ | PROT_WRITE references; and
  • removing mmap.rst from .nitignore.

The documented constants were verified against Modules/mmapmodule.c.

Validation:

  • Targeted Sphinx build completed with no warnings.
  • Full documentation HTML build passed in nitpicky mode with warnings treated as errors.
  • The documentation warning regression check passed.
  • The targeted mmap.rst nitpicky Sphinx build completed with no warnings.
  • The full CPython documentation warning comparison found no new regressions.

read-the-docs-community Bot commented Jul 15, 2026 •
edited
Loading

Copy link
Copy Markdown

Copy link
Copy Markdown

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

github-actions Bot added the stale Stale PR or inactive for long period of time. label Oct 18, 2026
Comment thread Doc/library/mmap.rst Outdated
Comment thread Doc/library/mmap.rst Outdated
Comment thread Doc/library/mmap.rst Outdated
Comment thread Doc/library/mmap.rst
Boyeep force-pushed the gh-151950-mmap-sphinx-refs branch from 4fdccce to e64c34e Compare October 19, 2026 21:07
Restore the introductory prose and document ACCESS_* in a separate
section. Use sentence case for headings and the availability directive.
Boyeep force-pushed the gh-151950-mmap-sphinx-refs branch from e64c34e to d1c44f9 Compare October 19, 2026 21:12
hugovk added needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Oct 19, 2026

Boyeep commented Oct 19, 2026

Copy link
Copy Markdown
Contributor Author

Thankss, i'll handle the backport

hugovk merged commit a3f5ccb into python:main Oct 21, 2026
38 checks passed

Copy link
Copy Markdown

Thanks @Boyeep for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14, 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

github-project-automation Bot moved this from Todo to Done in Docs PRs Oct 21, 2026

bedevere-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

GH-160077 is a backport of this pull request to the 3.15 branch.

Copy link
Copy Markdown

Sorry, @Boyeep and @hugovk, I could not cleanly backport this to 3.14 due to a conflict.

Please backport manually with cherry_picker, see the devguide for more information.

cherry_picker a3f5ccb5e384b7b13991345ca3b1188a9372fc0d 3.14

bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 21, 2026

bedevere-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

GH-160081 is a backport of this pull request to the 3.14 branch.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Oct 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news stale Stale PR or inactive for long period of time.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants


Back | FazBrowse Home | New Git URL