dstl / Stone-Soup

A software project to provide the target tracking community with a framework for the development and testing of tracking algorithms.
https://stonesoup.rtfd.io
MIT License
400 stars 131 forks source link

Plotter minor fix #702

Closed orosoman-dstl closed 2 years ago

orosoman-dstl commented 2 years ago

A small change to the Plotter and Plotterly classes. Previously, there was some contradiction between the documentation and whether or not the primary inputs to the various plot_ functions could be lists or sets. This change allows them to be either (ie a Collection), as both are suitable.

There are also a few miscellaneous grammar fixes to the radar documentation that I've thrown in.

codecov[bot] commented 2 years ago

Codecov Report

Merging #702 (7e654c3) into main (ee4ad3a) will decrease coverage by 0.04%. The diff coverage is 66.66%.

@@            Coverage Diff             @@
##             main     #702      +/-   ##
==========================================
- Coverage   94.48%   94.43%   -0.05%     
==========================================
  Files         171      171              
  Lines        8789     8794       +5     
  Branches     1705     1707       +2     
==========================================
+ Hits         8304     8305       +1     
- Misses        350      352       +2     
- Partials      135      137       +2     
Flag Coverage Δ
integration 69.36% <66.66%> (-0.03%) :arrow_down:
unittests 90.73% <26.66%> (-0.05%) :arrow_down:

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

Impacted Files Coverage Δ
stonesoup/sensor/radar/radar.py 95.67% <ø> (ø)
stonesoup/plotter.py 91.32% <66.66%> (-0.98%) :arrow_down:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.