From ef0e565337105922ac39074d200c7187b9c25410 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ignacio=20Mu=C3=B1oz=20Fernandez?= Date: Wed, 25 Nov 2020 20:54:46 +0100 Subject: [PATCH] chore: standarized parameters in game/utils.py and added docblocks --- game/utils.py | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/game/utils.py b/game/utils.py index 0d7dd201..530c559c 100644 --- a/game/utils.py +++ b/game/utils.py @@ -1,25 +1,45 @@ def meter_to_feet(value_in_meter: float) -> int: + """Converts meters to feets + + :arg value_in_meter Value in meters + """ return int(3.28084 * value_in_meter) def feet_to_meter(value_in_feet: float) -> int: + """Converts feets to meters + + :arg value_in_feet Value in feets + """ return int(value_in_feet / 3.28084) def meter_to_nm(value_in_meter: float) -> int: + """Converts meters to nautic miles + + :arg value_in_meter Value in meters + """ return int(value_in_meter / 1852) def nm_to_meter(value_in_nm: float) -> int: + """Converts nautic miles to meters + + :arg value_in_nm Value in nautic miles + """ return int(value_in_nm * 1852) -def knots_to_kph(knots: float) -> int: - return int(knots * 1.852) +def knots_to_kph(value_in_knots: float) -> int: + """Converts Knots to Kilometer Per Hour -def mps_to_knots(mps: float) -> int: + :arg value_in_knots Knots + """ + return int(value_in_knots * 1.852) + +def mps_to_knots(value_in_mps: float) -> int: """Converts Meters Per Second To Knots - :arg mps Meters Per Second + :arg value_in_mps Meters Per Second """ - return int(mps * 1.943) \ No newline at end of file + return int(value_in_mps * 1.943) \ No newline at end of file