[DOC] Fix malformed :param directive in HTTP2.gen_txt_repr docstring#5023
Merged
Conversation
Member
|
Thanks for the PR ! |
polybassa
pushed a commit
to polybassa/scapy-1
that referenced
this pull request
Jun 27, 2026
…#5023) AI-Assisted: yes (Cursor AI)
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.
Description
The docstring for HTTP2.gen_txt_repr documents its second argument with :param bool:, which names the type (bool) rather than the parameter. The actual parameter is register (signature: gen_txt_repr(self, hdrs, register=True)), so register was effectively undocumented and the directive was malformed. Corrected to :param bool register:, matching the Sphinx :param : style already used for hdrs on the line above. Docs only, no behaviour change.