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

Updating API documentation #1085

Merged
merged 1 commit into from
Feb 14, 2025
Merged

Updating API documentation #1085

merged 1 commit into from
Feb 14, 2025

Conversation

andrea-pasquale
Copy link
Contributor

@andrea-pasquale andrea-pasquale commented Feb 13, 2025

Closes #1084, it could be expanded a bit more. Let me know if more details are necessary.

@andrea-pasquale andrea-pasquale added the documentation Improvements or additions to documentation label Feb 13, 2025
Copy link

codecov bot commented Feb 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.31%. Comparing base (d8e8dda) to head (416b21f).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1085      +/-   ##
==========================================
- Coverage   97.33%   97.31%   -0.03%     
==========================================
  Files         123      123              
  Lines        9844     9844              
==========================================
- Hits         9582     9580       -2     
- Misses        262      264       +2     
Flag Coverage Δ
unittests 97.31% <ø> (-0.03%) ⬇️

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

see 4 files with indirect coverage changes

@Edoardo-Pedicillo Edoardo-Pedicillo added this pull request to the merge queue Feb 14, 2025
Merged via the queue into main with commit 852b163 Feb 14, 2025
21 checks passed
@Edoardo-Pedicillo Edoardo-Pedicillo deleted the fix_doc branch February 14, 2025 10:07
@stavros11
Copy link
Member

Thanks @andrea-pasquale, this is much more than concise compared to what I was doing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API example from documentation
4 participants