[CHORE] Changed keyword for todobot to only TODO

Author: Seluj78

.github/config.yml

@@ -1,2 +1,2 @@
 todo:
-  keyword: ['@todo', 'TODO:', 'TODO', '@todo:']
+  keyword: "@todo:"

42PyChecker.py

@@ -6,7 +6,7 @@
 import argparse
 import platform
 from PyChecker.projects import libft, ft_commandements, other
-# @todo Add verbose output
+# @todo: Add verbose output
 
 
 def print_header():
@@ -38,7 +38,7 @@ def main():
     parser.add_argument("--show-w", help="Displays the warranty warning from the license.", action="store_true")
     parser.add_argument("--show-c", help="Displays the conditions warning from the license.", action="store_true")
     parser.add_argument("--no-tests", help="Disables all the testing suites for the project.", action="store_true")
-    # @todo Check what option is given based on the selected project.
+    # @todo: Check what option is given based on the selected project.
     parser.add_argument("--no-required", help="Disables required functions check", action="store_true")
     parser.add_argument("--no-libft-unit-test", help="Disables libft-unit-test", action="store_true")
     # @todo: Fix --do-benchmark option for libft-unit-test
@@ -83,10 +83,10 @@ def main():
     print_header()
     if args.project == "libft":
         libft.check(root_path, args)
-    # @todo Handle options for 42commandements: No option can be passed (like --no-norm)
+    # @todo: Handle options for 42commandements: No option can be passed (like --no-norm)
     if args.project == "42commandements":
         ft_commandements.check(args)
-    # @todo Handle options for other: No option can be passed (like --no-norm)
+    # @todo: Handle options for other: No option can be passed (like --no-norm)
     if args.project == "other":
         other.check(root_path, args)
 

PyChecker/projects/libft.py

@@ -65,7 +65,7 @@ def check(root_path: str, args):
     bonus_functions = ['ft_lstnew.c', 'ft_lstdelone.c', 'ft_lstdel.c',
                        'ft_lstiter.c', 'ft_lstadd.c', 'ft_lstmap.c']
     authorized_functions = ['free', 'malloc', 'write', 'main']
-    # @todo add libft-unit-test to the testing suite
+    # @todo: add libft-unit-test to the testing suite
     if not args.no_author:
         author_results = author.check(args.path)
     if not args.no_required:
@@ -88,7 +88,7 @@ def check(root_path: str, args):
     if not args.no_maintest:
         maintest_ok, maintest_fail = maintest.run_libft(args.path, root_path)
     if not args.no_libft_unit_test:
-        # @todo Add return message/values to results for libft-unit-test
+        # @todo: Add return message/values to results for libft-unit-test
         libft_unit_test.run(root_path, args)
     print("\n\n\nThe results are in:\n")
     if not args.no_author:
@@ -97,7 +97,7 @@ def check(root_path: str, args):
         print("Required Functions: \n" + required_results + '\n')
     print("Bonus Functions: \n" + bonus_result + '\n')
     if not args.no_extra:
-        # @todo Stats on all c/h files of project, like with `cloc' ?
+        # @todo: Stats on all c/h files of project, like with `cloc' ?
         print("Extra Functions: -- You have {}\n".format(len(extra_functions)))
     if not args.no_norm:
         print("Norme results: \n" + norm_results + '\n')

PyChecker/projects/other.py

@@ -10,6 +10,6 @@ def check(root_path: str, args):
         author.check(args.path)
     if not args.no_norm:
         norme.check(args.path, root_path)
-    # @todo Add the makefile check and find the binary name itself
-    # @todo Add forbidden function check based on assumption of what the project is.
+    # @todo: Add the makefile check and find the binary name itself
+    # @todo: Add forbidden function check based on assumption of what the project is.
     return 0

PyChecker/testing_suite/libft_unit_test.py

@@ -29,4 +29,4 @@ def run(root_path: str, args):
             result = subprocess.run([root_path + '/testing_suites/libft-unit-test/run_test', '-b'], stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode('utf-8')
             print(result)
             file.write(result)
-    # @todo return results from benchmark and tests
+    # @todo: return results from benchmark and tests

PyChecker/testing_suite/maintest.py

@@ -41,10 +41,10 @@ def run_libft(project_path: str, root_path: str):
                           'lstadd', 'lstiter', 'lstmap']
     missing_functions = []
     for file in maintest_functions:
-        # @todo Add a check to handle libft where file aren't at libft/ but can be in libft/src
+        # @todo: Add a check to handle libft where file aren't at libft/ but can be in libft/src
         if not os.path.exists(project_path + '/ft_' + file + '.c'):
             missing_functions.append(file)
-    # @todo special case for memalloc and memdel
+    # @todo: special case for memalloc and memdel
     comment_define(root_path + '/testing_suites/Maintest/libft/main.c', root_path + '/libft_main.c', missing_functions)
     with open(root_path + "/.mymaintest", 'w+') as file:
         file.write("*------------------------------------------------------*\n")
@@ -62,12 +62,12 @@ def run_libft(project_path: str, root_path: str):
         print(result)
         result = subprocess.run([root_path + '/libft_main.out'], stdout=subprocess.PIPE,
                                 stderr=subprocess.STDOUT).stdout.decode('utf-8')
-        # @todo Count number of OK and FAILs and yellow tests to get score for maintest
+        # @todo: Count number of OK and FAILs and yellow tests to get score for maintest
         file.write(result + '\n')
         print(result)
     if platform.system() == "Linux":
         print("-- Disclaimer: Some of these test may fail where they woudn't on Darwin. (Because Linux ?)")
     os.remove(root_path + "/libft_main.c")
     os.remove(root_path + "/libft_main.out")
-    # @todo Check if FAIL is the right keyword.
+    # @todo: Check if FAIL is the right keyword.
     return result.count("OK"), result.count("FAIL")

PyChecker/testing_suite/moulitest.py

@@ -41,7 +41,7 @@ def execute_test(test_name: str, root_path: str):
         file.write("Warning: This file contains escape sequences. Please use"
                    " `cat' to view it properly.\n")
         file.write("*------------------------------------------------------*\n")
-        # @todo Get the result line of moulitest and parse it.
+        # @todo: Get the result line of moulitest and parse it.
         result = subprocess.run('make ' + test_name + ' -C ' + root_path +
                                 '/testing_suites/moulitest', shell=True,
                                 stdout=subprocess.PIPE,
@@ -67,7 +67,7 @@ def run(project_path: str, has_libft_bonuses: bool, project: str, root_path: str
         with open(root_path + "/testing_suites/moulitest/config.ini", 'w+') as file:
             file.write("LIBFT_PATH = " + project_path)
         include_libft_bonuses(root_path)
-        # @todo Fix moulitest makefile (it starts the bonus even when not asked.)
+        # @todo: Fix moulitest makefile (it starts the bonus even when not asked.)
         if not has_libft_bonuses:
             exclude_libft_bonuses(root_path)
             results = execute_test("libft_bonus", root_path)

PyChecker/utils/author.py

@@ -17,7 +17,7 @@ def check(project_path: str):
      2 if there's too many lines in the file,
      3 if the newline char is missing in the end of line
     """
-    # @todo message and handle multiple authors
+    # @todo: message and handle multiple authors
     print("*---------------------------------------------------------------*")
     print("*--------------------------Author file--------------------------*")
     print("*---------------------------------------------------------------*")

PyChecker/utils/forbidden_functions.py

@@ -21,7 +21,7 @@ def check(project_path: str, binary: str, authorized_func, root_path: str):
     print("*---------------------------------------------------------------*")
     ret = ""
     functions_called = []
-    # @todo Check difference between Darwin and Linux `nm'
+    # @todo: Check difference between Darwin and Linux `nm'
     subprocess.run(['make', '-C', project_path, 'all'], stdout=subprocess.PIPE,
                             stderr=subprocess.STDOUT)
     result = subprocess.run(['nm', project_path + '/' + binary],

PyChecker/utils/makefile.py

@@ -78,7 +78,7 @@ def check_makefile_all(project_path: str, binary_name: str, root_path: str):
                 print("-> Error when processing rule `all':"
                            " It should NOT have removed *.o")
                 error_count += 1
-            # @todo [ -z "$(echo ${MAKEALLTWICE} | grep -i "Nothing to be done")" -a -z "$(echo ${MAKEALLTWICE} | grep -i "is up to date")" ] && printf "%s\n" "-> Failing rule: Processing the rule 'all' twice in a row should result in nothing to be done" && RET=1
+            # @todo: [ -z "$(echo ${MAKEALLTWICE} | grep -i "Nothing to be done")" -a -z "$(echo ${MAKEALLTWICE} | grep -i "is up to date")" ] && printf "%s\n" "-> Failing rule: Processing the rule 'all' twice in a row should result in nothing to be done" && RET=1
     return error_count
 
 
@@ -253,7 +253,7 @@ def check_makefile_name(project_path: str, binary_name: str, root_path: str):
                 print("-> Error when processing rule `fclean': It should"
                            " NOT have removed *.o\n")
                 error_count += 1
-            # @todo [ -z "$(echo ${MAKEALLTWICE} | grep -i "Nothing to be done")" -a -z "$(echo ${MAKEALLTWICE} | grep -i "is up to date")" ] && printf "%s\n" "-> Failing rule: Processing the rule 'all' twice in a row should result in nothing to be done" && RET=1
+            # @todo: [ -z "$(echo ${MAKEALLTWICE} | grep -i "Nothing to be done")" -a -z "$(echo ${MAKEALLTWICE} | grep -i "is up to date")" ] && printf "%s\n" "-> Failing rule: Processing the rule 'all' twice in a row should result in nothing to be done" && RET=1
     return error_count