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

init documentation for user-supplied parameters checkings #972

Merged
merged 2 commits into from
Jul 4, 2023

Conversation

najaverzat
Copy link
Contributor

I start to write a description of what could be put in place to perform checks of user-supplied algorithms and parameters in src/api/checks_algos.md

@najaverzat najaverzat requested a review from guimarqu July 3, 2023 10:32
@codecov
Copy link

codecov bot commented Jul 3, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.59 ⚠️

Comparison is base (8fe4e38) 79.85% compared to head (339b19c) 79.26%.

❗ Current head 339b19c differs from pull request most recent head 148a3ff. Consider uploading reports for the commit 148a3ff to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #972      +/-   ##
==========================================
- Coverage   79.85%   79.26%   -0.59%     
==========================================
  Files          85       85              
  Lines        6125     6087      -38     
==========================================
- Hits         4891     4825      -66     
- Misses       1234     1262      +28     

see 16 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@guimarqu guimarqu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok but I think we should name the page "Algorithms and initialization"

@guimarqu guimarqu marked this pull request as ready for review July 4, 2023 11:51
@guimarqu guimarqu merged commit dea2220 into master Jul 4, 2023
@guimarqu guimarqu deleted the doc_alg_interface branch July 4, 2023 11:51
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.

2 participants