Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docstrings to adhere to Google docstrings standard #1225

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

DonDebonair
Copy link
Owner

  • update docstrings for Message
  • update docstrings for Command
  • update docstrings for BlockAction
  • update docstrings for ModalSubmission and ModalClosure
  • update docstrings for decorators
  • update docstrings for storage classes

…#1213)

- update docstrings for `Message`
- update docstrings for `Command`
- update docstrings for `BlockAction`
- update docstrings for `ModalSubmission` and `ModalClosure`
- update docstrings for decorators
- update docstrings for storage classes
@DonDebonair DonDebonair merged commit 1ecae29 into main Nov 26, 2024
6 checks passed
@DonDebonair DonDebonair deleted the docs/fix-docstrings branch November 26, 2024 15:29
Copy link

codecov bot commented Nov 26, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 79.71%. Comparing base (fdfaaf0) to head (35bf837).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/machine/plugins/message.py 66.66% 2 Missing ⚠️
src/machine/plugins/base.py 83.33% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1225   +/-   ##
=======================================
  Coverage   79.71%   79.71%           
=======================================
  Files          36       36           
  Lines        1957     1957           
=======================================
  Hits         1560     1560           
  Misses        397      397           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant