From d8babdda7ec53b39e712cc921f4bc0dee67f264c Mon Sep 17 00:00:00 2001 From: Tom Arne Pedersen Date: Fri, 17 Jan 2025 13:06:30 +0100 Subject: [PATCH] #43 Updating documentation --- docs/source/_autosummary/trafficgen.read_files.rst | 1 - src/trafficgen/encounter.py | 3 ++- src/trafficgen/marine_system_simulator.py | 4 ++-- src/trafficgen/plot_traffic_situation.py | 3 ++- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/source/_autosummary/trafficgen.read_files.rst b/docs/source/_autosummary/trafficgen.read_files.rst index 696df7f..eb08b2c 100644 --- a/docs/source/_autosummary/trafficgen.read_files.rst +++ b/docs/source/_autosummary/trafficgen.read_files.rst @@ -10,7 +10,6 @@ .. autosummary:: camel_to_snake - check_input_units convert_encounters convert_keys_to_snake_case convert_own_ship_initial_data diff --git a/src/trafficgen/encounter.py b/src/trafficgen/encounter.py index 2ad2763..ca0fd02 100644 --- a/src/trafficgen/encounter.py +++ b/src/trafficgen/encounter.py @@ -840,7 +840,8 @@ def assign_beta_from_list(beta_limit: list[float]) -> float: The beta between own ship and target ship depending is somewhere between the limits given by beta_limit. - Params: + Parameters + ---------- beta_limit : list[float] Limits for beta {min, max} [rad] diff --git a/src/trafficgen/marine_system_simulator.py b/src/trafficgen/marine_system_simulator.py index 60001a9..552e52b 100644 --- a/src/trafficgen/marine_system_simulator.py +++ b/src/trafficgen/marine_system_simulator.py @@ -49,8 +49,8 @@ def flat2llh( Flat earth coordinate located at (lon_0, lat_0) z_n : float Ship position, down [m], default is 0.0 - * h_ref=0.0: Flat earth coordinate with reference h_ref in meters above the surface - of the ellipsoid + h_ref : float + Flat earth coordinate with reference h_ref in meters above the surface of the ellipsoid, default is 0.0 Returns ------- diff --git a/src/trafficgen/plot_traffic_situation.py b/src/trafficgen/plot_traffic_situation.py index d7b55df..da03068 100644 --- a/src/trafficgen/plot_traffic_situation.py +++ b/src/trafficgen/plot_traffic_situation.py @@ -336,7 +336,8 @@ def find_max_value_for_plot( """ Find the maximum deviation from the Reference point in north and east direction. - Params: + Parameters + ---------- ship : Ship Ship information max_value : float