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

Skills module tests, docstrings, and annotations #108

Merged
merged 16 commits into from
Jul 10, 2023
Merged

Skills module tests, docstrings, and annotations #108

merged 16 commits into from
Jul 10, 2023

Conversation

NeonDaniel
Copy link
Member

@NeonDaniel NeonDaniel commented Jul 7, 2023

Log deprecation for backwards-compat references
Reorganizes unit tests to separate legacy tests ported from mycroft-core
Adds type annotations and docstrings to methods within the skills module
Adds init tests to all classes to validate expected parameters and properties
Stubs tests for skill methods to be filled in over time

@codecov
Copy link

codecov bot commented Jul 7, 2023

Codecov Report

Merging #108 (36396d1) into dev (0cdf027) will increase coverage by 57.67%.
The diff coverage is 75.43%.

❗ Current head 36396d1 differs from pull request most recent head 7f09ac4. Consider uploading reports for the commit 7f09ac4 to get more accurate results

@@            Coverage Diff             @@
##             dev     #108       +/-   ##
==========================================
+ Coverage   0.00%   57.67%   +57.67%     
==========================================
  Files         33       33               
  Lines       3173     3213       +40     
==========================================
+ Hits           0     1853     +1853     
+ Misses      3173     1360     -1813     
Impacted Files Coverage Δ
ovos_workshop/decorators/converse.py 0.00% <0.00%> (ø)
ovos_workshop/decorators/fallback_handler.py 0.00% <0.00%> (ø)
ovos_workshop/skills/active.py 100.00% <ø> (+100.00%) ⬆️
ovos_workshop/skills/decorators/__init__.py 0.00% <0.00%> (ø)
ovos_workshop/skills/decorators/converse.py 0.00% <0.00%> (ø)
...vos_workshop/skills/decorators/fallback_handler.py 0.00% <0.00%> (ø)
ovos_workshop/skills/decorators/killable.py 0.00% <0.00%> (ø)
ovos_workshop/skills/decorators/layers.py 0.00% <0.00%> (ø)
ovos_workshop/skills/decorators/ocp.py 0.00% <0.00%> (ø)
ovos_workshop/skills/intent_provider.py 0.00% <0.00%> (ø)
... and 12 more

... and 10 files with indirect coverage changes

Add deprecation log to layers.py
Update docstrings, type annotations, and deprecation warnings in mycroft_skill.py
Refactor `MycroftSkill` tests to a separate module to separate legacy code in tests
@NeonDaniel NeonDaniel requested a review from JarbasAl July 8, 2023 03:33
@NeonDaniel NeonDaniel marked this pull request as ready for review July 10, 2023 16:45
@JarbasAl JarbasAl added documentation Improvements or additions to documentation enhancement New feature or request automations and tests labels Jul 10, 2023
@JarbasAl JarbasAl merged commit 2d5c1d7 into dev Jul 10, 2023
11 checks passed
@JarbasAl JarbasAl deleted the DOC_Skills branch July 10, 2023 18:09
@github-actions github-actions bot mentioned this pull request Jul 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automations and tests documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants