gh-125756: Document Pickler.clear_memo
#125762
Open
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.
Documents the public
clear_memo
which is currently undocumented. I think it makes to have it in the docs given that it is need when reusingPickler
objects.The documentation is a copy of the docstring, but perhaps we could make it even clearer by replacing
This method is useful when re-using picklers.
with something likeWhen reusing picklers, this method should be called after every call to dump
?📚 Documentation preview 📚: https://cpython-previews--125762.org.readthedocs.build/