Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update references and documentation of Updater classes #683

Merged
merged 2 commits into from
Jul 29, 2022

Conversation

ekhunter123
Copy link
Contributor

I have updated the documentation for the ChernoffUpdater class. This included editing the documentation to be clearer, and adding another reference. I also specified the parameters and returns of the class methods, following the style of the other update classes.

Second, I added another reference to the PHDUpdater class. This reference specifies the track management system that is used in the class, namely using track tags. This distinguishes it from the tree-based track management algorithms.

@ekhunter123 ekhunter123 requested a review from a team as a code owner July 28, 2022 20:17
@ekhunter123 ekhunter123 requested review from nperree-dstl and jwragg-dstl and removed request for a team July 28, 2022 20:17
@codecov
Copy link

codecov bot commented Jul 28, 2022

Codecov Report

Merging #683 (1593703) into main (0e8a394) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #683   +/-   ##
=======================================
  Coverage   94.60%   94.60%           
=======================================
  Files         170      170           
  Lines        8544     8544           
  Branches     1652     1652           
=======================================
  Hits         8083     8083           
  Misses        342      342           
  Partials      119      119           
Flag Coverage Δ
integration 68.55% <ø> (ø)
unittests 92.11% <ø> (ø)

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

Impacted Files Coverage Δ
stonesoup/updater/chernoff.py 92.30% <ø> (ø)
stonesoup/updater/pointprocess.py 95.94% <ø> (ø)

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 0e8a394...1593703. Read the comment docs.

@sdhiscocks sdhiscocks merged commit 708198c into dstl:main Jul 29, 2022
@ekhunter123 ekhunter123 deleted the add_references branch July 29, 2022 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants