Skip to content

Commit 729d7c9

Browse files
committed
[CHORE] Added todobot config and changed all todos to remove colons
1 parent 4073465 commit 729d7c9

File tree

8 files changed

+14
-12
lines changed

8 files changed

+14
-12
lines changed

.github/.config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
todo:
2+
keyword: ['@todo', 'TODO:', 'TODO', '@todo:', '@TODO', '@TODO:']

42PyChecker.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import argparse
77
import platform
88
from PyChecker.projects import libft, ft_commandements, other
9-
# @todo: Add verbose output
9+
# @todo Add verbose output
1010

1111

1212
def print_header():
@@ -82,10 +82,10 @@ def main():
8282
print_header()
8383
if args.project == "libft":
8484
libft.check(root_path, args)
85-
# @todo: Handle options for 42commandements: No option can be passed (like --no-norm)
85+
# @todo Handle options for 42commandements: No option can be passed (like --no-norm)
8686
if args.project == "42commandements":
8787
ft_commandements.check(args)
88-
# @todo: Handle options for other: No option can be passed (like --no-norm)
88+
# @todo Handle options for other: No option can be passed (like --no-norm)
8989
if args.project == "other":
9090
other.check(root_path, args)
9191

PyChecker/projects/libft.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ def check(root_path: str, args):
8888
if not args.no_maintest:
8989
maintest_ok, maintest_fail = maintest.run_libft(args.path, root_path)
9090
if not args.no_libft_unit_test:
91-
# @todo: Add return message/values to results for libft-unit-test
91+
# @todo Add return message/values to results for libft-unit-test
9292
libft_unit_test.run(root_path, args)
9393
print("\n\n\nThe results are in:\n")
9494
if not args.no_author:

PyChecker/projects/other.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ def check(root_path: str, args):
1010
author.check(args.path)
1111
if not args.no_norm:
1212
norme.check(args.path, root_path)
13-
# @todo: Add the makefile check and find the binary name itself
14-
# @todo: Add forbidden function check based on assumption of what the project is.
13+
# @todo Add the makefile check and find the binary name itself
14+
# @todo Add forbidden function check based on assumption of what the project is.
1515
return 0

PyChecker/testing_suite/libft_unit_test.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ def run(root_path: str, args):
5555
result = subprocess.run([root_path + '/testing_suite/libft-unit-test/run_test', '-b'], stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode('utf-8')
5656
print(result)
5757
file.write(result)
58-
# @todo: return results from benchmark and tests
58+
# @todo return results from benchmark and tests

PyChecker/testing_suite/maintest.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def run_libft(project_path: str, root_path: str):
4444
# @todo Add a check to handle libft where file aren't at libft/ but can be in libft/src
4545
if not os.path.exists(project_path + '/ft_' + file + '.c'):
4646
missing_functions.append(file)
47-
# @todo: special case for memalloc and memdel
47+
# @todo special case for memalloc and memdel
4848
comment_define(root_path + '/testing_suites/Maintest/libft/main.c', root_path + '/libft_main.c', missing_functions)
4949
with open(root_path + "/.mymaintest", 'w+') as file:
5050
file.write("*------------------------------------------------------*\n")
@@ -62,7 +62,7 @@ def run_libft(project_path: str, root_path: str):
6262
print(result)
6363
result = subprocess.run([root_path + '/libft_main.out'], stdout=subprocess.PIPE,
6464
stderr=subprocess.STDOUT).stdout.decode('utf-8')
65-
# @todo: Count number of OK and FAILs and yellow tests to get score for maintest
65+
# @todo Count number of OK and FAILs and yellow tests to get score for maintest
6666
file.write(result + '\n')
6767
print(result)
6868
if platform.system() == "Linux":

PyChecker/utils/makefile.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ def check_makefile_all(project_path: str, binary_name: str, root_path: str):
7878
print("-> Error when processing rule `all':"
7979
" It should NOT have removed *.o")
8080
error_count += 1
81-
# @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
81+
# @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
8282
return error_count
8383

8484

@@ -253,7 +253,7 @@ def check_makefile_name(project_path: str, binary_name: str, root_path: str):
253253
print("-> Error when processing rule `fclean': It should"
254254
" NOT have removed *.o\n")
255255
error_count += 1
256-
# @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
256+
# @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
257257
return error_count
258258

259259

PyChecker/utils/static.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ def check(root_path: str, args):
1313
result = subprocess.run(['sh', root_path + '/scripts/check_static.sh', args.path],
1414
stdout=subprocess.PIPE).stdout.decode('utf-8')
1515
file.write(result)
16-
# @todo: Replace check_static script with a python way of doing it
16+
# @todo Replace check_static script with a python way of doing it
1717
print(result)
1818
return result

0 commit comments

Comments
 (0)