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

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

Draft
wants to merge 24 commits into
base: master
Choose a base branch
from

Conversation

jdkent
Copy link
Contributor

@jdkent jdkent commented Mar 4, 2021

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...).

@codecov-io
Copy link

codecov-io commented Mar 5, 2021

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%) ⬇️
pliers/support/decorators.py 80.00% <0.00%> (-1.82%) ⬇️
pliers/transformers/api/google.py 40.00% <0.00%> (-1.18%) ⬇️
pliers/transformers/api/microsoft.py 25.00% <0.00%> (-1.16%) ⬇️
pliers/stimuli/api.py 37.73% <0.00%> (-1.16%) ⬇️
pliers/converters/api/revai.py 25.75% <0.00%> (-1.11%) ⬇️
pliers/converters/api/ibm.py 24.71% <0.00%> (-0.84%) ⬇️
pliers/converters/base.py 90.00% <0.00%> (-0.63%) ⬇️
pliers/extractors/api/clarifai.py 22.40% <0.00%> (-0.62%) ⬇️
pliers/utils/base.py 84.61% <0.00%> (-0.57%) ⬇️
... 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.

@adelavega
Copy link
Member

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

@jdkent
Copy link
Contributor Author

jdkent commented Mar 5, 2021

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

@adelavega
Copy link
Member

@jdkent whatever happened to this old PR?

Can you rebase master and see if tests pass?

@jdkent
Copy link
Contributor Author

jdkent commented Sep 21, 2022

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

@adelavega
Copy link
Member

That's probably right.

@adelavega adelavega marked this pull request as draft November 14, 2022 23:35
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.

3 participants