ADA-SVR (2/4) add comments and documentation of the functions and test

[lionelkusch]

This pull request is the next step after #58 .
This is an example of a template of documentation for functions.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.72%. Comparing base (19e6cf7) to head (c146efe).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #73      +/-   ##
==========================================
+ Coverage   81.70%   81.72%   +0.02%     
==========================================
  Files          43       43              
  Lines        2312     2315       +3     
==========================================
+ Hits         1889     1892       +3     
  Misses        423      423              

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

[bthirion]

The PR looks good but we should think of codebase organization.
Moreover ada_svr is too cryptic to be a good module name.

[bthirion]

I think I'd rather not have ada_svr as a module directly under hidimstat. Should be in something like hidimstat.estimators.

[lionelkusch]

It's fine for me.
Do you prefer call this module: procedures or methods or models ?

[bthirion]

maybe models.
But we should first discuss the organization of the whole thing to make a good decision.

[lionelkusch]

See the issue #86

[lionelkusch]

I added a function for computing the pvalue from the output of ada_svr.

[lionelkusch]

I add a definition of all . This is from the advice of this section.