gh-151950: Fix dangling class reference in pickletools docs#152209
gh-151950: Fix dangling class reference in pickletools docs#152209BHUVANSH855 wants to merge 1 commit into
Conversation
BHUVANSH855
force-pushed
the
gh-151950-pickletools
branch
2 times, most recently
from
1193a9c to
acc1683
Compare
BHUVANSH855
requested review from
AA-Turner,
StanFromIreland and
hugovk
as code owners
| 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 |
There was a problem hiding this comment.
I think we should document it instead.
There was a problem hiding this comment.
Implemented as suggested.
OpcodeInfo is now documented in Doc/library/pickletools.rst, and genops() now links to the documented class.
I have made the requested changes; please review again.
|
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 |
BHUVANSH855
force-pushed
the
gh-151950-pickletools
branch
from
acc1683 to
c17a831
Compare
Documentation build overview
6 files changed ·
|
2 participants
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.