Commit 4804d672 authored by Fabian Kovac's avatar Fabian Kovac
Browse files

[i] updated source code comments

parent 6a343afa
...@@ -51,11 +51,10 @@ def parse_arguments() -> argparse.Namespace: ...@@ -51,11 +51,10 @@ def parse_arguments() -> argparse.Namespace:
def _log(msg: str) -> None: def _log(msg: str) -> None:
"""Logs messages if verbose flag is set to True """Logs message
Parameters: Parameters:
msg (str): Message to log to console msg (str): Message to log to console
verbose (bool): Outputs message if set to True
""" """
# add marker to log message # add marker to log message
...@@ -70,7 +69,7 @@ def _log(msg: str) -> None: ...@@ -70,7 +69,7 @@ def _log(msg: str) -> None:
def load_inca_file(file_inca: pathlib.Path) -> np.array: def load_inca_file(file_inca: pathlib.Path) -> np.array:
"""Loads loads gzipped INCA data to a given file """Loads gzipped INCA data of a given file
Parameters: Parameters:
file_inca (pathlib.Path): Path to INCA file file_inca (pathlib.Path): Path to INCA file
...@@ -89,7 +88,7 @@ def load_inca_file(file_inca: pathlib.Path) -> np.array: ...@@ -89,7 +88,7 @@ def load_inca_file(file_inca: pathlib.Path) -> np.array:
def load_inca_data(dir_inca: pathlib.Path) -> np.array: def load_inca_data(dir_inca: pathlib.Path) -> np.array:
"""Loads inca files to a given inca dir """Loads inca files of a given inca dir
Parameters: Parameters:
dir_inca (pathlib.Path): Directory for INCA files dir_inca (pathlib.Path): Directory for INCA files
...@@ -239,7 +238,7 @@ def utm_to_lambert(lon: np.array, lat: np.array) -> tuple: ...@@ -239,7 +238,7 @@ def utm_to_lambert(lon: np.array, lat: np.array) -> tuple:
def lambert_to_inca_idx(x: np.array, y: np.array) -> tuple: def lambert_to_inca_idx(x: np.array, y: np.array) -> tuple:
"""Convert x and y of Lambert Conic Conformal Projection to INCA index """Convert x and y of Lambert Conic Conformal Projection to an INCA index
Parameters: Parameters:
x (np.array): Vector containing x values in meter of Lambert Conformal Conic Projection x (np.array): Vector containing x values in meter of Lambert Conformal Conic Projection
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment