Skip to content
Snippets Groups Projects
Commit 3b95f61c authored by Matthieu Muller's avatar Matthieu Muller
Browse files

Some changes to the docs

parent 27e73da0
No related branches found
No related tags found
No related merge requests found
......@@ -76,6 +76,9 @@ def check_cfa(cfa: str) -> None:
Args:
cfa (str): CFA name.
Raises:
Exception: Exception if the name of the CFA is not correct.
"""
if cfa not in ['bayer', 'quad_bayer']:
raise Exception(f'Unknown CFA name. Got {cfa} but expected either bayer or quad_bayer.')
......
......@@ -26,10 +26,10 @@ def load_image(file_path: str) -> np.ndarray:
"""Loads the image located in file_path.
Args:
file_path (str): Path of the file containing the image. Must end by '.png'.
file_path (str): Path to the file containing the image. Must end by '.png'.
Returns:
np.ndarray: The loaded image.
np.ndarray: Loaded image.
"""
check_path(file_path)
check_png(file_path)
......@@ -41,7 +41,7 @@ def save_image(file_path: str, img: np.ndarray) -> None:
"""Saves the image located in file_path.
Args:
file_path (str): Path of the file in which the image will be saved. Must end by '.png'.
file_path (str): Path to the file in which the image will be saved. Must end by '.png'.
img (np.ndarray): Image to save.
"""
check_path(file_path.split('/')[-2])
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment