Skip to content

[3.11] Docs: Improve multiprocessing.SharedMemory reference (#114093) #114138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jan 16, 2024

(cherry picked from b1db627)

Align the multiprocessing shared memory docs with Diatáxis's
recommendations for references.

  • use a parameter list for the SharedMemory.init() argument spec
  • use the imperative mode
  • use versionadded, not versionchanged, for added parameters
  • reflow touched lines according to SemBr

📚 Documentation preview 📚: https://cpython-previews--114138.org.readthedocs.build/

…14093)

(cherry picked from b1db627)

Align the multiprocessing shared memory docs with Diatáxis's
recommendations for references.

- use a parameter list for the SharedMemory.__init__() argument spec
- use the imperative mode
- use versionadded, not versionchanged, for added parameters
- reflow touched lines according to SemBr
@erlend-aasland erlend-aasland requested a review from tiran as a code owner January 16, 2024 17:12
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting core review labels Jan 16, 2024
@erlend-aasland erlend-aasland enabled auto-merge (squash) January 16, 2024 17:14
@erlend-aasland erlend-aasland merged commit 2122e1e into python:3.11 Jan 16, 2024
@erlend-aasland erlend-aasland deleted the 3.11-backport-shmem-reference branch January 16, 2024 17:18
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant