search

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
385 stars 127 forks source link

Improve example documentation #840

Closed mharris-dstl closed 8 months ago

mharris-dstl commented 10 months ago

Should improve readability and ensure flake8 tests pass for some examples. Just documentation addition - no coding changes.

Have also changed types/association to fix a typo raised by @A-acuto and put in some full stops while I was there.

A-acuto commented 10 months ago

I've just seen a small typo (missing colon before class:~) in the association description of the function associations_including_objects in the AssociationSet data type , if you prefer I can fix it here in this PR

A-acuto commented 9 months ago

Hi, I've found a documentation typo in functions.build_rotation_matrix, likely an extra tab in the first entry of the Parameters part which breaks the layout. Like this: image

Probably removing the tab before angle_vector, and keeping the rest of the text as it is, will fix this issue.

mharris-dstl commented 9 months ago

Hi, I've found a documentation typo in functions.build_rotation_matrix, likely an extra tab in the first entry of the Parameters part which breaks the layout. Like this: image

Probably removing the tab before angle_vector, and keeping the rest of the text as it is, will fix this issue.

Happy to do this in a follow-up PR - just don't want to keep making this one bigger when it's primarily about example docs :)

mharris-dstl commented 9 months ago

Have committed changes made by @hpritchett-dstl