Document full public API for mkdocstrings RTD - #15
Merged
Conversation
Add Google-style docstrings on BMP565, ClipContext/ClippedCanvas, FrameBuffer properties, Draw/Font __init__, and related public methods; list format constants in the package docstring; export RGB888 in __all__.
Contributor
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
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.
Summary
Google-style docstrings on the public
pygraphicssurface so mkdocstrings no longer omits members (show_if_no_docstring: false).BMP565,ClipContext/ClippedCanvas,FrameBufferprops,Draw/Font/_filesRGB888added to__all__Verified with local
mkdocs build(BMP565 methods appear inreference/pygraphics/).