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

Fix: Sphinx doctest internal/task.py #1097

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

gogetron
Copy link
Contributor

Summary

🎯 Purpose: Fix doctest in cleanlab/datalab/internal/task.py to be compatible with sphinx

[ ✏️ Write your summary here. ]

The output of cd docs && make doctest produces 10 fewer errors with this PR compared with current version.
In addition python3 -m doctest cleanlab/datalab/internal/task.py produces no errors.

Testing

🔍 Testing Done: Existing test suite, python3 -m doctest cleanlab/datalab/internal/task.py and cd docs && make doctest.

Links to Relevant Issues or Conversations

#1092

References

Reviewer Notes

💡 Include any specific points for the reviewer to consider during their review.

I would like to keep working on fixing the remaining failing doctest, so let me know if a different style is preferred when working on them.

Copy link

codecov bot commented Apr 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.20%. Comparing base (0221f8b) to head (79ffd80).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1097      +/-   ##
==========================================
+ Coverage   96.18%   96.20%   +0.02%     
==========================================
  Files          76       76              
  Lines        5996     6015      +19     
  Branches      992     1000       +8     
==========================================
+ Hits         5767     5787      +20     
  Misses        135      135              
+ Partials       94       93       -1     

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

None yet

1 participant