Maintenance update review claas optional - #88
Merged
tomarnepedersen merged 10 commits intoMar 17, 2026
Merged
Conversation
…of underlines in .rst files where Sphinx build issued warnings.
…otation in docstring of function `convert_ship_data_from_si_units_to_maritime()`
…n docstring of functions `find_max_value_for_plot()` and `add_ship_to_plot()`
…f function `generate_encounter()`
…of function `read_situation_from_file()`
…sions`, enforcing Sphinx to not parse the ASCII art that visualises the ship dimensions, but render it as plain text. Formerly, the ASCII art caused warnings and errors when building the Sphinx documentation, as Sphinx tried to parse and make sense of it (and certainly failed :-) ).
…annotation of field `length`. Annotation said (wrong) `Width`. Now corrected to `Length`.
…API documentation of the trafficgen package in the Sphinx documentation.
…e/trafficgen.rst, to include the types.py module in the Sphinx documentation.
Merged
tomarnepedersen
approved these changes
Mar 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Optional addition to the Sphinx documentation which includes the API (i.e. the Python modules inside the trafficgen package) in the generated Sphinx documentation.