chore: add PEP 484 return-type annotations to mellea.stdlib public me…#1263
Conversation
ajbozarth
left a comment
ajbozarth
left a comment
There was a problem hiding this comment.
This LGTM outside of the small docstring CI failure. Also you need to make sure to use git commit -s to add Signed-off-by to your commit to pass DCO
|
|
||
| def parts(self): | ||
| def parts(self) -> list[Component | CBlock]: | ||
| """Returns all of the constituent parts of an Instruction.""" |
There was a problem hiding this comment.
an example fix to address the CI failure
| """Returns all of the constituent parts of an Instruction.""" | |
| """Returns all of the constituent parts of an Instruction. | |
| Returns: | |
| The constituent parts of the Instruction. | |
| """ |
There was a problem hiding this comment.
fyi -- copied from the details of the DCO check fail:
DCO
There is one commit incorrectly signed off. This means that the author of this commit failed to include a Signed-off-by line in the commit message.
To avoid having PRs blocked in the future, always include Signed-off-by: Author Name authoremail@example.com in every commit message. You can also do this automatically by using the -s flag (i.e., git commit -s).
Here is how to fix the problem so that this code can be merged.
Rebase the branch
If you have a local git environment and meet the criteria below, one option is to rebase the branch and add your Signed-off-by lines in the new commits. Please note that if others have already begun work based upon the commits in this branch, this solution will rewrite history and may cause serious issues for collaborators (described in the git documentation under "The Perils of Rebasing").
You should only do this if:
You are the only author of the commits in this branch
You are absolutely certain nobody else is doing any work based upon this branch
There are no empty commits in the branch (for example, a DCO Remediation Commit which was added using --allow-empty)
To add your Signed-off-by line to every commit in this branch:
Ensure you have a local copy of your branch by checking out the pull request locally via command line.
In your local branch, run: git rebase HEAD~1 --signoff
Force push your changes to overwrite the branch: git push --force-with-lease origin symbiote/plan-mellea-stdlib-annotations
Summary
Commit sha: 8bfaab3, Author: Yehor Kaliberda, Committer: Yehor Kaliberda; The sign-off is missing.
3 participants
Partial fix for #1177 — adds return-type annotations to the 5 griffe warnings on the mellea.stdlib public surface.
Changes
mellea/stdlib/session.py: MelleaSession.reset → -> None, MelleaSession.powerup → -> None
mellea/stdlib/components/instruction.py: Instruction.parts → -> list[Component | CBlock]
mellea/stdlib/components/docs/richdocument.py: RichDocument.to_markdown → -> str, Table.parts → -> list[Component | CBlock]
No logic changes — purely additive metadata. Backend protocol methods (processing, post_processing) and the broader all question are left for a follow-up once the public surface is decided.
Generated and verified by Symbiote — autonomous Python annotation engine.