From 821c5fc563c66fad6a259b9501851894b8f7dbdf Mon Sep 17 00:00:00 2001 From: Maria Fernanda Magallanes Zubillaga Date: Mon, 26 Aug 2024 16:35:51 -0500 Subject: [PATCH] docs: improve code docs --- tutorpicasso/commands/enable_private_packages.py | 2 +- tutorpicasso/commands/run_extra_commands.py | 6 ------ 2 files changed, 1 insertion(+), 7 deletions(-) diff --git a/tutorpicasso/commands/enable_private_packages.py b/tutorpicasso/commands/enable_private_packages.py index dcc55bf..1036355 100644 --- a/tutorpicasso/commands/enable_private_packages.py +++ b/tutorpicasso/commands/enable_private_packages.py @@ -114,7 +114,7 @@ def get_picasso_packages(settings: Dict[str, Any]) -> Dict[str, Dict[str, Any]]: settings (dict): The tutor configuration settings. Returns: - dict: A dictionary of distribution packages, where the keys are package names + A dictionary of distribution packages, where the keys are package names and the values are package details. """ picasso_packages = { diff --git a/tutorpicasso/commands/run_extra_commands.py b/tutorpicasso/commands/run_extra_commands.py index 4a5ecfc..afced20 100644 --- a/tutorpicasso/commands/run_extra_commands.py +++ b/tutorpicasso/commands/run_extra_commands.py @@ -114,12 +114,6 @@ def find_tutor_misspelled(command: str) -> bool: Return: True if any misspelled occurrence is found, False otherwise. - - Args: - command (str): Command to be reviewed - - Return: - If its found the word 'tutor' misspelled is returned True """ return bool(re.match(r"[tT](?:[oru]{3}|[oru]{2}[rR]|[oru]u?)", command))