docs: fix MelleaPlugin/MelleaBasePayload missing from API coverage (#…#670
Merged
planetf1 merged 2 commits intogenerative-computing:mainfrom Mar 17, 2026
Merged
Conversation
Contributor
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Contributor
Author
|
Tested with/without package, for docstrings & in vscode, and tests. |
…enerative-computing#667) Replace dual if/else class definitions with dynamic base classes so Griffe's static AST parser sees a single ClassDef node per class and always picks up the authoritative docstring.
planetf1
force-pushed
the
docs/plugin-api-coverage-667
branch
from
c8567ea to
506e3f9
Compare
The Sphinx :param:/:return: style is not recognised by Griffe's quality audit. Convert to Google Args/Returns sections.
jakelorocco
approved these changes
Mar 17, 2026
Merged
via the queue into
generative-computing:main
with commit Mar 17, 2026
17d48d7
8 of 9 checks passed
8 tasks
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.
Misc PR
Type of PR
Description
Fixes #667
Replace dual
if/elseclass definitions inmellea/plugins/base.pywith dynamic base classes (Option 2 from #667) so Griffe's static AST parser sees a singleClassDefnode per class and always picks up the authoritative docstring. Stub__init__is applied post-hoc when cpex is not installed to preserve the existingImportErrorbehaviour.Also converts
check_certaintyandrequirement_checkinmellea/stdlib/components/intrinsic/core.pyfrom Sphinx:param:/:return:style to GoogleArgs:/Returns:sections so Griffe's quality audit recognises them. These were introduced in #551.Testing