Skip to content

Improve API documentation #149

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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Improve API documentation #149

wants to merge 6 commits into from

Conversation

staadecker
Copy link
Member

@staadecker staadecker commented Jun 23, 2025

Copy link
Contributor

github-actions bot commented Jun 23, 2025

Lines Of Code

Language Files Lines Code Comments Blanks Complexity Bytes
HTML 4 (+2) 77 (+46) 69 (+38) 2 (+2) 6 (+6) 0 3K (+1.9K)
JSON 2 (+1) 16 (+6) 16 (+6) 0 0 0 297B (+107B)
JavaScript 1 (+1) 26 (+26) 20 (+20) 0 6 (+6) 4 (+4) 643B (+643B)
Markdown 25 (+1) 734 (+2) 477 (+2) 0 257 0 28.5K (+22B)
Python 40 (+2) 6358 (+258) 5515 (+240) 367 (+2) 476 (+16) 215 (+4) 208.3K (+7.9K)
YAML 15 853 (+22) 634 (+20) 157 62 (+2) 0 26.7K (+581B)
gitignore 1 17 (+1) 17 (+1) 0 0 0 174B (+26B)

Copy link

codecov bot commented Jun 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.77%. Comparing base (242b14b) to head (79bb1bd).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #149      +/-   ##
==========================================
+ Coverage   96.73%   96.77%   +0.03%     
==========================================
  Files           9        9              
  Lines        1257     1271      +14     
==========================================
+ Hits         1216     1230      +14     
  Misses         41       41              
Flag Coverage Δ
smart-tests 96.77% <100.00%> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

Document Config options in API reference.
1 participant