lkilcher / dolfyn

A library for oceanographic doppler instruments such as Acoustic Doppler Profilers (ADPs, ADCPs) and Acoustic Doppler Velocimeters (ADVs).
BSD 3-Clause "New" or "Revised" License
42 stars 25 forks source link

Documentation and variable-name updates! #32

Closed lkilcher closed 5 years ago

lkilcher commented 5 years ago

This resolves #28, #30, #26, and #25.

lkilcher commented 5 years ago

It also resolves #24.

codecov[bot] commented 5 years ago

Codecov Report

Merging #32 into master will decrease coverage by 0.22%. The diff coverage is 82.35%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #32      +/-   ##
==========================================
- Coverage   44.19%   43.97%   -0.23%     
==========================================
  Files          62       61       -1     
  Lines        7003     6986      -17     
==========================================
- Hits         3095     3072      -23     
- Misses       3908     3914       +6
Impacted Files Coverage Δ
dolfyn/rotate/base_nortek.py 93.1% <ø> (ø) :arrow_up:
dolfyn/data/velocity.py 46.66% <ø> (ø) :arrow_up:
dolfyn/rotate/vector.py 82.72% <ø> (-0.16%) :arrow_down:
dolfyn/adv/turbulence.py 42.5% <0%> (+3.86%) :arrow_up:
dolfyn/test/test_rotate_adv.py 86.76% <100%> (ø) :arrow_up:
dolfyn/test/test_adv.py 77.06% <100%> (ø) :arrow_up:
dolfyn/test/test_read_adp.py 77.5% <100%> (+3.97%) :arrow_up:
dolfyn/io/api.py 92.3% <100%> (ø) :arrow_up:
dolfyn/_version.py 76.47% <100%> (ø) :arrow_up:
dolfyn/test/base.py 84.61% <100%> (ø) :arrow_up:
... and 2 more

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 cf28b19...ee8fe9c. Read the comment docs.

lkilcher commented 5 years ago

Alright, this is good to go! Thanks especially to @mcfogarty for pointing out so many of these issues.