Update signature_with_def option in pydocs generator#1855
Merged
barryyosi-panw merged 1 commit intoApr 12, 2026
Conversation
YairGlick
approved these changes
Apr 12, 2026
Contributor
Preview Site AvailableCongratulations! The automatic build has completed successfully. Important: Make sure to inspect your changes at the preview site. |
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
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.
Status
Ready
Related Issues
fixes: CRTX-238825
Description
The bug was introduced by commit fef4c9a ("migrate pydoc markdown to v4 #1853") on March 23, 2026.
In pydoc-markdown v3 (3.10.0),
MarkdownRenderer.signature_with_defdefaulted toFalse.In pydoc-markdown v4 (>=4.8.2),
MarkdownRenderer.signature_with_defdefaults toTrue.The migration did NOT add
signature_with_def=Falseto theDemistoMarkdownRendererinstantiation ingenerate_pydoc(), causingdefto be prepended to all function signatures in code blocks.