gh-151950: Fix dangling class reference in pickletools docs#152209
Open
BHUVANSH855 wants to merge 1 commit into
Open
gh-151950: Fix dangling class reference in pickletools docs#152209BHUVANSH855 wants to merge 1 commit into
BHUVANSH855 wants to merge 1 commit into
Conversation
BHUVANSH855
force-pushed
the
gh-151950-pickletools
branch
from
0702076 to
1193a9c
Compare
BHUVANSH855
force-pushed
the
gh-151950-pickletools
branch
from
1193a9c to
acc1683
Compare
BHUVANSH855
requested review from
AA-Turner,
StanFromIreland and
hugovk
as code owners
StanFromIreland
requested changes
Jun 25, 2026
| Provides an :term:`iterator` over all of the opcodes in a pickle, returning a | ||
| sequence of ``(opcode, arg, pos)`` triples. *opcode* is an instance of an | ||
| :class:`OpcodeInfo` class; *arg* is the decoded value, as a Python object, of | ||
| :class:`!OpcodeInfo` class; *arg* is the decoded value, as a Python object, of |
Member
There was a problem hiding this comment.
I think we should document it instead.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
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
2 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.
Issue
gh-151950
Description
This PR fixes a dangling Sphinx class reference in
Doc/library/pickletools.rst.The reference to
OpcodeInfopointed to an undocumented internal class, producing a Sphinx warning. This change replaces the cross-reference with:class:!OpcodeInfo`` to preserve the formatting while suppressing the unresolved reference.