gh-141004: Mark up docs of old PyMem macros #143783
Open
+17
−11
Conversation
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
Their docs-only deprecation notice appeared 2.0: https://docs.python.org/release/2.0/api/memoryInterface.html but not 1.6: https://docs.python.org/release/2.0/api/memoryInterface.html Nowadays we call this soft deprecation. Since PEP 445, they are now direct aliases; there are no (additional) binary compatibility concerns over the preferred names.
encukou
added
topic-C-API
docs
Comment on lines
+296
to
+301
| .. c:macro:: PyMem_MALLOC(size) | ||
| PyMem_NEW(type, size) | ||
| PyMem_REALLOC(ptr, size) | ||
| PyMem_RESIZE(ptr, type, size) | ||
| PyMem_FREE(ptr) | ||
| PyMem_DEL(ptr) |
Member
There was a problem hiding this comment.
I think it would be nice to have a table, similar to what I did here.
vstinner
reviewed
Jan 13, 2026
| .. versionchanged:: 3.4 | ||
| The macros are now aliases of the corresponding mixed-case names. | ||
| Previously, their of the macros was the same, but their use did |
Member
There was a problem hiding this comment.
Sorry, I don't get the sentence: "their of the macros was the same".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These had a docs-only deprecation notice since the first version of the docs in this repo. Nowadays we call things “soft deprecated” if there's just a note in the docs.
The
deprecateddirective needs a version, I went with the first one that had the notice (2.0; it's not in 1.6).Since PEP 445, they are now direct aliases; there are no (additional) binary compatibility concerns over the preferred names.
📚 Documentation preview 📚: https://cpython-previews--143783.org.readthedocs.build/