Skip to content

Commit 53c25c6

Browse files
committed
Add docstring for GitAutograderExercise
1 parent c7441e7 commit 53c25c6

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/git_autograder/exercise.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,28 @@
2121

2222

2323
class GitAutograderExercise:
24+
"""This is the central Git-Mastery exercise grading layer. It essentially provides a
25+
central layer to create autograding for a given exercise.
26+
27+
Exercises have the following folder structure::
28+
29+
exercise_root/
30+
|_ README.md
31+
|_ .gitmastery-exercise.json
32+
|_ *resource_files
33+
|_ repo/
34+
|_ .git/
35+
36+
:param exercise_path: Path to a given exercise folder
37+
:type exercise_path: Union[str, os.PathLike]
38+
"""
2439
def __init__(
2540
self,
2641
exercise_path: str | os.PathLike,
2742
) -> None:
43+
"""Constructor method
44+
"""
45+
2846
# TODO: We should not be starting the grading at the point of initializing, but
2947
# we're keeping this because of the exception system
3048
self.started_at = self.__now()

0 commit comments

Comments
 (0)