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
388 stars 128 forks source link

Add more documentation for GaussianMixtureReducer. #770

Closed mattbrown11 closed 1 year ago

mattbrown11 commented 1 year ago

Added a little more detail to the doc for GaussianMixtureReducer properties. Looks like my IDE also removed trailing whitespaces, hope that isn't an issue.

codecov[bot] commented 1 year ago

Codecov Report

Base: 94.80% // Head: 94.80% // No change to project coverage :thumbsup:

Coverage data is based on head (5eac282) compared to base (b33f56c). Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #770 +/- ## ======================================= Coverage 94.80% 94.80% ======================================= Files 175 175 Lines 9456 9456 Branches 1884 1884 ======================================= Hits 8965 8965 Misses 350 350 Partials 141 141 ``` | Flag | Coverage Δ | | |---|---|---| | integration | `69.38% <100.00%> (ø)` | | | unittests | `89.67% <100.00%> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/dstl/Stone-Soup/pull/770?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl) | Coverage Δ | | |---|---|---| | [stonesoup/mixturereducer/gaussianmixture.py](https://codecov.io/gh/dstl/Stone-Soup/pull/770?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl#diff-c3RvbmVzb3VwL21peHR1cmVyZWR1Y2VyL2dhdXNzaWFubWl4dHVyZS5weQ==) | `97.77% <100.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.