-
Notifications
You must be signed in to change notification settings - Fork 4
Documentation and bug fix ready to be merged #74
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
Conversation
…chema, add links to input/output file pages from usage page
…ocumentation Add documentation on output files (new page), add links to maritime schema, add links to input/output file pages from usage page.
…in-output-situation-files 68 ts id numbers are same in output situation files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR addresses ship ID numbering issues and improves documentation with several key improvements to the traffic generation system.
- Fixed ship ID assignments to ensure unique IDs across own ship and target ships
- Enhanced documentation with better output file descriptions and navigation links
- Updated version numbers and CHANGELOG entries to reflect the bug fixes
Reviewed Changes
Copilot reviewed 66 out of 68 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/trafficgen/read_files.py | Fixed ship ID defaults from 0 to 1 for own ship and improved target ship ID calculation |
| src/trafficgen/encounter.py | Updated target ship ID assignment logic to be relative to own ship ID |
| src/trafficgen/cli.py | Removed duplicate verbosity option and improved type annotation |
| docs/source/output_files.rst | Added new comprehensive documentation for output file format |
| docs/source/usage.rst | Enhanced usage documentation with better organization and cross-references |
| pyproject.toml | Updated version from 0.8.1 to 0.8.2 |
| Multiple JSON files | Updated ship IDs and version numbers in generated traffic situations |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Ownship ID is now 1, so update example output. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Target ship IDs now start at 2, update example. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@tomarnepedersen It seems that if I specify an ID for the target ships in the target ship .json config files, they get ignored. I tried by adding an ID (random nr, 25) in target_ship_2.json. |
|
it is correct that target ship IDs are ignored at the moment. The reason is that same target ship may be used several times, and then they will have the same ID. I haven't used time to figure out a solution for this. |
… get it if you ran -v and so I rather limit it now to the exact functionality involved
StephanieKemna
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments were directly in PR - discussed here and in person, oddities fixed, so looking good now!
Check that documentation is working, and that the target ship numbering is ok.
This PR resolves #68