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

docs(api): improve api documentation #3343

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

ReenigneArcher
Copy link
Member

Description

Adds clearer API documentation. This closes out an item in the roadmap.

Screenshot

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

@ReenigneArcher ReenigneArcher force-pushed the docs/api/improve-api-documentation branch from 9698dca to 5fa3b4f Compare October 30, 2024 19:48
@ReenigneArcher ReenigneArcher enabled auto-merge (squash) October 30, 2024 19:53
Copy link

Copy link

codecov bot commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 11.14%. Comparing base (d8fbe2d) to head (5fa3b4f).
Report is 95 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #3343    +/-   ##
========================================
  Coverage   11.14%   11.14%            
========================================
  Files          99       99            
  Lines       17185    17186     +1     
  Branches     8009     8009            
========================================
+ Hits         1915     1916     +1     
- Misses      12582    12724   +142     
+ Partials     2688     2546   -142     
Flag Coverage Δ
Linux 8.45% <ø> (ø)
Windows 5.22% <ø> (ø)
macOS-13 13.64% <100.00%> (+0.01%) ⬆️
macOS-14 12.63% <ø> (ø)

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

Files with missing lines Coverage Δ
src/confighttp.cpp 2.25% <100.00%> (+0.18%) ⬆️

... and 21 files with indirect coverage changes

@ReenigneArcher ReenigneArcher merged commit ec0cdcf into master Oct 30, 2024
36 checks passed
@ReenigneArcher ReenigneArcher deleted the docs/api/improve-api-documentation branch October 30, 2024 20:34
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.

1 participant