Honour the package's __docformat__ when rendering docstrings - #96
Merged
Conversation
lightpanda-python is switching to Google-style Args sections in its docstrings (lightpanda-io/lightpanda-python#7). Convert docstrings with the docformat the package declares instead of assuming reST, render pdoc's section headings as bold labels so they stay out of the page outline, and leave list-item continuation lines alone when fencing indented blocks.
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
1 participant
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.
Companion to lightpanda-io/lightpanda-python#7, which adds Google-style
Args:sections to every generated method and declares__docformat__ = "google"on the package.###### Arguments:) as bold labels so they do not land in the page outline.textfence.The page itself does not change until the Python PR is merged and the daily workflow regenerates it; I verified the output against that branch locally.