Add Google-style docstrings for RTD API reference - #3
Merged
Conversation
Document module overviews, WIN16, get_palette, Palette, MappedPalette, WheelPalette, CubePalette, and MDPalette with Args, Returns, Raises, and Examples so mkdocstrings generates complete RTD API pages. Co-authored-by: Brad Barnett <bdbarnett@users.noreply.github.com>
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.
Improves Read the Docs API reference by adding Google-style docstrings to all public modules and symbols documented by mkdocstrings.
Documented API
palettes: module overview,WIN16,get_palette,Palette,MappedPalettepalettes.wheel:WheelPaletteconstructor and behaviorpalettes.cube:CubePaletteconstructor and cube sizingpalettes.material_design:MDPaletteand named shade/accent attributesEach public class and method includes Args, Returns, and Raises sections where applicable. Also fixes a typo in
cube.pySPDX header.