search

darpa-sail-on / sail-on-client

Client and Protcols for DARPA Sail On.
https://darpa-sail-on.github.io/sail-on-client/index.html
Other
2 stars 0 forks source link

Update Documentation #131

Closed as6520 closed 3 years ago

as6520 commented 3 years ago

This PR updates the documentation in the following ways

  1. Changes the links in the documentation from gitlab to github
  2. Fixes docstrings across all modules in the package
  3. Adds documentation for metrics, feedback and saving features/attributes
  4. Adds intersphinx mapping and version string in the documentation

Depends on #130

Closes #75

codecov[bot] commented 3 years ago

Codecov Report

Merging #131 (290a5c0) into master (b743d3e) will decrease coverage by 0.006%. The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff              @@
##            master      #131       +/-   ##
=============================================
- Coverage   92.602%   92.596%   -0.006%     
=============================================
  Files           39        39               
  Lines         2379      2377        -2     
=============================================
- Hits          2203      2201        -2     
  Misses         176       176
Impacted Files Coverage Δ
...n-client/sail_on_client/protocol/localinterface.py 99.270% <0.000%> (-0.011%) :arrow_down:
sail-on-client/sail_on_client/checkpointer.py 79.012% <0.000%> (ø)
sail-on-client/sail_on_client/errors/errors.py 93.548% <0.000%> (ø)
sail-on-client/sail_on_client/protocol/condda.py 79.545% <0.000%> (ø)
...-on-client/sail_on_client/protocol/ond_protocol.py 69.110% <0.000%> (ø)
...-on-client/sail_on_client/protocol/parinterface.py 96.875% <0.000%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update c6dab40...290a5c0. Read the comment docs.