pliers icon indicating copy to clipboard operation
pliers copied to clipboard

[ENH,DOC,TST] use doctest and sphinx gallery to test/display examples

Open jdkent opened this issue 4 years ago • 6 comments

related to #445.

This pull request begins to add doctest to the relevant inline examples and attempts to use sphinx-gallery to build examples (most of the examples require API keys causing them to fail...).

jdkent avatar Mar 04 '21 23:03 jdkent

Codecov Report

Merging #450 (05c8be4) into master (244d08f) will decrease coverage by 0.26%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #450      +/-   ##
==========================================
- Coverage   75.73%   75.46%   -0.27%     
==========================================
  Files          65       65              
  Lines        3820     3779      -41     
==========================================
- Hits         2893     2852      -41     
  Misses        927      927              
Impacted Files Coverage Δ
pliers/converters/api/wit.py 45.65% <0.00%> (-2.27%) :arrow_down:
pliers/support/decorators.py 80.00% <0.00%> (-1.82%) :arrow_down:
pliers/transformers/api/google.py 40.00% <0.00%> (-1.18%) :arrow_down:
pliers/transformers/api/microsoft.py 25.00% <0.00%> (-1.16%) :arrow_down:
pliers/stimuli/api.py 37.73% <0.00%> (-1.16%) :arrow_down:
pliers/converters/api/revai.py 25.75% <0.00%> (-1.11%) :arrow_down:
pliers/converters/api/ibm.py 24.71% <0.00%> (-0.84%) :arrow_down:
pliers/converters/base.py 90.00% <0.00%> (-0.63%) :arrow_down:
pliers/extractors/api/clarifai.py 22.40% <0.00%> (-0.62%) :arrow_down:
pliers/utils/base.py 84.61% <0.00%> (-0.57%) :arrow_down:
... and 11 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 244d08f...05c8be4. Read the comment docs.

codecov-io avatar Mar 05 '21 00:03 codecov-io

Cool! Ready for review? Looks like I need to fix something in the pull request docks check

adelavega avatar Mar 05 '21 17:03 adelavega

not yet! I switched to running github actions locally to stop the madness!

jdkent avatar Mar 05 '21 17:03 jdkent

@jdkent whatever happened to this old PR?

Can you rebase master and see if tests pass?

adelavega avatar Sep 21 '22 17:09 adelavega

yeah, i can do that, but I feel like there was some blocker that resulted in me not being being able to finish.

jdkent avatar Sep 21 '22 18:09 jdkent

That's probably right.

adelavega avatar Sep 21 '22 18:09 adelavega